model/plc-phy.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2012 University of British Columbia, Vancouver
 *
 * 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: Alexander Schloegl <alexander.schloegl@gmx.de>
 */

#ifndef PLC_PHY_H_
#define PLC_PHY_H_

#include <cmath>
#include <vector>
#include <ns3/object.h>
#include <ns3/nstime.h>
#include <ns3/traced-value.h>
#include <ns3/trace-source-accessor.h>
#include "plc-interface.h"
#include "plc-header.h"
#include "plc-outlet.h"
#include "plc-link-performance-model.h"
#include "plc-channel.h"

namespace ns3 {

// Forward declarations
class PLC_TrxMetaInfo;
class PLC_Channel;
class PLC_ChannelTransferImpl;
class PLC_LinkPerformanceModel;

typedef enum
{
        CHANNEL_CLEAR,
        CHANNEL_OCCUPIED
} PLC_PhyCcaResult;

// Callback definitions
typedef Callback<void, Ptr<const Packet> > PhyRxEndOkCallback;
typedef Callback< void > PhyRxEndErrorCallback;
typedef Callback< void, PLC_PhyCcaResult > PLC_PhyCcaConfirmCallback;
typedef Callback<void> PLC_PhyDataFrameSentCallback;
typedef std::vector<std::pair<Time, Ptr<const SpectrumValue> > > PLC_SinrTrace;

// Helper functions
size_t RequiredSymbols (size_t encoded_bits, ModulationAndCodingType mcs, size_t subbands);
Time CalculateTransmissionDuration(size_t encoded_bits, ModulationAndCodingType mcs, size_t subbands);


size_t RawBitsPerOfdmSymbol (ModulationAndCodingType mcs, size_t numSubcarriers);
size_t RawBytesInOfdmSymbols (ModulationAndCodingType mcs, size_t numSubCarriers, size_t num_bytes);

class PLC_Phy : public Object
{
public:

        virtual ~PLC_Phy ();

        static TypeId GetTypeId (void);

        bool StartTx (Ptr<Packet> p);

        void StartRx (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);

        void RxPsdChanged (uint32_t txId, Ptr<SpectrumValue> newRxPsd);

        static void SetSymbolDuration (Time tSymbol);

        static Time GetSymbolDuration (void);

        Ptr<PLC_Node> GetNode (void) { return m_node; }

        void SetDataFrameSentCallback (PLC_PhyDataFrameSentCallback c);

        void SetReceiveSuccessCallback (PhyRxEndOkCallback c);

        void SetReceiveErrorCallback (PhyRxEndErrorCallback c);

        PLC_ChannelTransferImpl *GetChannelTransferImpl (Ptr<PLC_Phy> rxPhy);

        Ptr<PLC_TransferBase> GetChannelTransferVector(Ptr<PLC_Phy> rxPhy);


        void NotifyDataFrameSent (void);

protected:
        static Time symbol_duration;

        virtual void DoStart (void);
        virtual void DoDispose (void);

        virtual bool DoStartTx (Ptr<Packet> p) = 0;
        virtual void DoStartRx (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo) = 0;
        virtual void DoUpdateRxPsd (uint32_t txId, Ptr<SpectrumValue> newRxPsd) = 0;
        virtual PLC_ChannelTransferImpl *DoGetChannelTransferImpl (Ptr<PLC_Phy> rxPhy) = 0;

        Ptr<PLC_Node> m_node;

        PLC_PhyDataFrameSentCallback    m_data_frame_sent_callback;
        PhyRxEndOkCallback                              m_receive_success_cb;
        PhyRxEndErrorCallback                   m_receive_error_cb;
};

class PLC_HalfDuplexOfdmPhy : public PLC_Phy
{
public:

        enum State
        {
                IDLE,
                TX,
                RX,
        };

        static TypeId GetTypeId (void);

        PLC_HalfDuplexOfdmPhy ();
        virtual ~PLC_HalfDuplexOfdmPhy () = 0;

        static void SetGuardIntervalDuration (Time duration);;
        static Time GetGuardIntervalDuration (void);

        void CreateInterfaces (Ptr<PLC_Outlet> outlet, Ptr<SpectrumValue> txPsd, Ptr<PLC_Impedance> rxImpedance = 0, Ptr<PLC_Impedance> txImpedance = 0);

        Ptr<PLC_Outlet> GetOutlet (void) { return m_outlet; }

        void SetTxPowerSpectralDensity (Ptr<SpectrumValue> txPsd);

        Ptr<const SpectrumValue> GetTxPowerSpectralDensity (void) { return m_txPsd; }

        Ptr<PLC_TxInterface> GetTxInterface (void);

        Ptr<PLC_RxInterface> GetRxInterface (void);

        void SetShuntImpedance (Ptr<PLC_Impedance> shuntImpedance);

        void SetRxImpedance (Ptr<PLC_Impedance> rxImpedance);

        void SetTxImpedance (Ptr<PLC_Impedance> txImpedance);

        Ptr<PLC_Impedance> GetShuntImpedance (void) { return m_shuntImpedance; }

        Ptr<PLC_Impedance> GetRxImpedance (void) { return m_rxImpedance; }

        Ptr<PLC_Impedance> GetTxImpedance (void) { return m_txImpedance; }

        void SetNoiseFloor (Ptr<const SpectrumValue> noiseFloor);

        void CcaRequest (void);

        void CancelCca (void);

        void EndCca (void);

        void SetCcaConfirmCallback (PLC_PhyCcaConfirmCallback c);

        void ChangeState (State newState);

        State GetState (void);

        bool IsBusy(void) { return m_state != IDLE; }

protected:
        virtual void DoStart (void);
        virtual void DoDispose (void);
        virtual void DoSetNoiseFloor (Ptr<const SpectrumValue> noiseFloor) = 0;
        virtual PLC_ChannelTransferImpl *DoGetChannelTransferImpl (Ptr<PLC_Phy> rxPhy);

        static Time guard_interval_duration;

        void ComputeEquivalentImpedances (void);
        virtual PLC_PhyCcaResult ClearChannelAssessment (void) = 0;

        Time CalculateTxDuration (size_t nSymbols);

        void SwitchImpedance (State state);

        Ptr<PLC_Outlet>                 m_outlet;
        Ptr<SpectrumValue>              m_txPsd;
        Ptr<PLC_TxInterface>    m_txInterface;
        Ptr<PLC_RxInterface>    m_rxInterface;
        Ptr<PLC_Impedance>              m_shuntImpedance;
        Ptr<PLC_Impedance>              m_txImpedance;
        Ptr<PLC_Impedance>              m_rxImpedance;
        Ptr<PLC_Impedance>              m_eqRxImpedance;
        Ptr<PLC_Impedance>              m_eqTxImpedance;

        size_t                                  m_numSubcarriers;

        uint32_t m_locked_txId;
        Ptr<Packet> m_incoming_packet;

        // The PHY has to be aware of all receive PSDs to
        // update the interference model when a signal changes
        std::map<uint32_t, Ptr<const SpectrumValue> > m_rxNoisePsdMap;

        EventId m_ccaEndEvent;
        PLC_PhyCcaConfirmCallback m_ccaConfirmCallback;

        State m_state;
        TracedCallback<Time, State> m_PhyStateLogger;
};

class PLC_ErrorRatePhy : public PLC_HalfDuplexOfdmPhy
{
public:
        static TypeId GetTypeId (void);

        PLC_ErrorRatePhy();

        virtual void SetModulationAndCodingScheme(ModulationAndCodingType mcs);
        ModulationAndCodingType GetModulationAndCodingScheme(void) { return m_mcs; }

        virtual void PreambleDetectionSuccessful (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);
        virtual void EndRx(uint32_t txId);

private:
        virtual void DoStart (void);
        virtual void DoDispose (void);
        virtual void DoSetNoiseFloor (Ptr<const SpectrumValue> noiseFloor);
        virtual bool DoStartTx (Ptr<Packet> p);
        virtual void DoStartRx (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);
        virtual void DoUpdateRxPsd (uint32_t txId, Ptr<SpectrumValue> newRxPsd);

        PLC_PhyCcaResult ClearChannelAssessment (void);
        Time CalculateTxDuration(Ptr<const Packet> p);

        ModulationAndCodingType m_mcs;
        Ptr<const Packet> m_rxPacket;
        Ptr<PLC_ErrorRateModel> m_error_rate_model;
};

class PLC_InformationRatePhy : public PLC_HalfDuplexOfdmPhy
{
public:
        static TypeId GetTypeId (void);

        PLC_InformationRatePhy (void);

        void SetHeaderModulationAndCodingScheme(ModulationAndCodingType mcs);
        ModulationAndCodingType GetHeaderModulationAndCodingScheme(void);

        void SetPayloadModulationAndCodingScheme(ModulationAndCodingType mcs);
        ModulationAndCodingType GetPayloadModulationAndCodingScheme(void);

        static void SetOfdmSymbolsPerCodeBlock (size_t spb);

        size_t GetOfdmSymbolsPerCodeBlock (void);

        static void SetRatelessCodingOverhead (double overhead);
        static double GetRatelessCodingOverhead (void) { return rateless_coding_overhead; }

        void EndRxHeader(Ptr<SpectrumValue>& rxPsd, Ptr<const PLC_TrxMetaInfo> metaInfo);
        void EndRxPayload(Ptr<const PLC_TrxMetaInfo> metaInfo);
        void ReceptionFailure(void);

        void SendFrame (Ptr<Packet> p, Ptr<PLC_TrxMetaInfo> metaInfo);

        virtual void PreambleDetectionSuccessful (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);

protected:
        static size_t modulation_symbols_per_code_block;
        static double rateless_coding_overhead;

        virtual void DoStart (void);
        virtual void DoDispose (void);
        virtual void DoSetNoiseFloor (Ptr<const SpectrumValue> noiseFloor);
        virtual bool DoStartTx (Ptr<Packet> p);
        virtual void DoStartRx (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);
        virtual void DoUpdateRxPsd (uint32_t txId, Ptr<SpectrumValue> newRxPsd);

        virtual void StartReception (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);
        virtual void NotifySuccessfulReception (void);

        Ptr<Packet> CreateEncodedPacket (Ptr<PLC_TrxMetaInfo> metaInfo);
        Ptr<Packet> CreateFixedRateEncodedPacket (Ptr<PLC_TrxMetaInfo> metaInfo);
        Ptr<Packet> CreateRatelessEncodedPacket (Ptr<PLC_TrxMetaInfo> metaInfo);

        PLC_PhyCcaResult ClearChannelAssessment (void);

        size_t RequiredChunks (size_t num_blocks);
        size_t ChunksInByte (size_t num_chunks, size_t raw_bits_per_symbol);

        Ptr<PLC_InformationRateModel> m_information_rate_model;

        ModulationAndCodingType m_header_mcs;
        ModulationAndCodingType m_payload_mcs;
};

class PLC_ChaseCombiningPhy : public PLC_InformationRatePhy
{
public:
        static TypeId GetTypeId (void);

        PLC_ChaseCombiningPhy(void);

        void UpdateSinrBase (Ptr<const SpectrumValue> newSinrBase);
        void TraceSinr(Time t, Ptr<const SpectrumValue> sinr);

protected:
        virtual void DoStart (void);
        virtual void DoDispose (void);

        virtual void StartReception (Ptr<const Packet> p, uint32_t txId, Ptr<SpectrumValue>& rxPsd, Time duration, Ptr<const PLC_TrxMetaInfo> metaInfo);
        virtual void NotifySuccessfulReception (void);

private:
        Time m_rxStartTime;
        Ptr<const Packet> m_rxPacketRef;
        PLC_SinrTrace m_sinrBaseTrace;
};

// TODO: PLC_IncrementalRedundancyPhy

}

#endif /* PLC_PHY_H_ */