19#include "ns3/antenna-model.h"
20#include "ns3/boolean.h"
21#include "ns3/config.h"
22#include "ns3/double.h"
24#include "ns3/object-factory.h"
25#include "ns3/simulator.h"
26#include "ns3/trace-source-accessor.h"
45 0.08, 0.1, 0.11, 0.15, 0.19, 0.24, 0.3, 0.37, 0.44, 0.51, 0.3, 0.33, 0.37, 0.42, 0.48,
46 0.54, 0.6, 0.43, 0.45, 0.5, 0.55, 0.6, 0.65, 0.7, 0.75, 0.8, 0.85, 0.89, 0.92,
101 for (uint8_t i = 0; i < 7; i++)
176 TypeId(
"ns3::LteSpectrumPhy")
179 .AddTraceSource(
"TxStart",
180 "Trace fired when a new transmission is started",
182 "ns3::PacketBurst::TracedCallback")
183 .AddTraceSource(
"TxEnd",
184 "Trace fired when a previously started transmission is finished",
186 "ns3::PacketBurst::TracedCallback")
187 .AddTraceSource(
"RxStart",
188 "Trace fired when the start of a signal is detected",
190 "ns3::PacketBurst::TracedCallback")
191 .AddTraceSource(
"RxEndOk",
192 "Trace fired when a previously started RX terminates successfully",
194 "ns3::Packet::TracedCallback")
195 .AddTraceSource(
"RxEndError",
196 "Trace fired when a previously started RX terminates with an error",
198 "ns3::Packet::TracedCallback")
199 .AddAttribute(
"DataErrorModelEnabled",
200 "Activate/Deactivate the error model of data (TBs of PDSCH and PUSCH) "
201 "[by default is active].",
205 .AddAttribute(
"CtrlErrorModelEnabled",
206 "Activate/Deactivate the error model of control (PCFICH-PDCCH "
207 "decodification) [by default is active].",
211 .AddTraceSource(
"DlPhyReception",
212 "DL reception PHY layer statistics.",
214 "ns3::PhyReceptionStatParameters::TracedCallback")
215 .AddTraceSource(
"UlPhyReception",
216 "DL reception PHY layer statistics.",
218 "ns3::PhyReceptionStatParameters::TracedCallback");
410 NS_FATAL_ERROR(
"cannot TX while RX: according to FDD channel access, the physical layer "
411 "for transmission cannot be used for reception");
417 NS_FATAL_ERROR(
"cannot TX while already TX: the MAC should avoid this");
437 txParams->duration = duration;
441 txParams->packetBurst = pb;
442 txParams->ctrlMsgList = ctrlMsgList;
466 NS_FATAL_ERROR(
"cannot TX while RX: according to FDD channel access, the physical layer "
467 "for transmission cannot be used for reception");
473 NS_FATAL_ERROR(
"cannot TX while already TX: the MAC should avoid this");
499 txParams->ctrlMsgList = ctrlMsgList;
522 NS_FATAL_ERROR(
"cannot TX while RX: according to FDD channel access, the physical layer "
523 "for transmission cannot be used for reception");
529 NS_FATAL_ERROR(
"cannot TX while already TX: the MAC should avoid this");
606 Time duration = spectrumRxParams->duration;
621 else if (lteDlCtrlRxParams)
626 else if (lteUlSrsRxParams)
648 NS_FATAL_ERROR(
"cannot RX while TX: according to FDD channel access, the physical layer "
649 "for transmission cannot be used for reception");
665 NS_LOG_LOGIC(
this <<
" synchronized with this signal (cellId=" << params->cellId
675 << params->duration.As(
Time::S));
691 if (params->packetBurst)
698 NS_LOG_DEBUG(
this <<
" insert msgs " << params->ctrlMsgList.size());
700 params->ctrlMsgList.begin(),
701 params->ctrlMsgList.end());
707 NS_LOG_LOGIC(
this <<
" not in sync with this signal (cellId=" << params->cellId
708 <<
", m_cellId=" <<
m_cellId <<
")");
731 cellId = lteDlCtrlRxParams->cellId;
748 if (lteDlCtrlRxParams->pss)
761 NS_LOG_LOGIC(
this <<
" ignoring other DlCtrl (cellId=" << cellId
762 <<
", m_cellId=" <<
m_cellId <<
")");
768 NS_LOG_LOGIC(
this <<
" synchronized with this signal (cellId=" << cellId <<
")");
774 << lteDlCtrlRxParams->duration);
786 NS_LOG_LOGIC(
this <<
" not synchronizing with this signal (cellId=" << cellId
787 <<
", m_cellId=" <<
m_cellId <<
")");
814 NS_FATAL_ERROR(
"cannot RX while TX: according to FDD channel access, the physical layer "
815 "for transmission cannot be used for reception");
833 cellId = lteUlSrsRxParams->cellId;
836 NS_LOG_LOGIC(
this <<
" synchronized with this signal (cellId=" << cellId <<
")");
845 << lteUlSrsRxParams->duration);
865 NS_LOG_LOGIC(
this <<
" not in sync with this signal (cellId=" << cellId
866 <<
", m_cellId=" <<
m_cellId <<
")");
891 std::vector<int> map,
897 NS_LOG_FUNCTION(
this <<
" rnti: " << rnti <<
" NDI " << (uint16_t)ndi <<
" size " << size
898 <<
" mcs " << (uint16_t)mcs <<
" layer " << (uint16_t)layer <<
" rv "
910 tbInfo_t tbInfo = {ndi, size, mcs, map, harqId, rv, 0.0, downlink,
false,
false};
911 m_expectedTbs.insert(std::pair<TbId_t, tbInfo_t>(tbId, tbInfo));
921 for (uint8_t i = 0; i < 2; i++)
961 if ((*itTb).second.ndi == 0)
964 uint16_t ulHarqId = 0;
965 if ((*itTb).second.downlink)
969 (*itTb).first.m_layer);
978 (*itTb).second.rbBitmap,
982 (*itTb).second.mi = tbStats.
mi;
983 (*itTb).second.corrupt = !(
m_random->GetValue() > tbStats.
tbler);
984 NS_LOG_DEBUG(
this <<
"RNTI " << (*itTb).first.m_rnti <<
" size " << (*itTb).second.size
985 <<
" mcs " << (
uint32_t)(*itTb).second.mcs <<
" bitmap "
986 << (*itTb).second.rbBitmap.size() <<
" layer "
987 << (uint16_t)(*itTb).first.m_layer <<
" TBLER " << tbStats.
tbler
988 <<
" corrupted " << (*itTb).second.corrupt);
994 params.m_rnti = (*itTb).first.m_rnti;
996 params.m_layer = (*itTb).first.m_layer;
997 params.m_mcs = (*itTb).second.mcs;
998 params.m_size = (*itTb).second.size;
999 params.m_rv = (*itTb).second.rv;
1000 params.m_ndi = (*itTb).second.ndi;
1001 params.m_correctness =
static_cast<uint8_t
>(!(*itTb).second.corrupt);
1003 if ((*itTb).second.downlink)
1011 params.m_rv = harqInfoList.size();
1018 std::map<uint16_t, DlInfoListElement_s> harqDlInfoMap;
1021 for (
auto j = (*i)->Begin(); j != (*i)->End(); ++j)
1025 (*j)->PeekPacketTag(tag);
1037 if (!(*itTb).second.corrupt)
1053 if ((*itTb).second.harqFeedbackSent)
1058 (*itTb).second.harqFeedbackSent =
true;
1059 if (!(*itTb).second.downlink)
1063 harqUlInfo.
m_tpc = 0;
1064 if ((*itTb).second.corrupt)
1071 (*itTb).second.size,
1079 (*itTb).second.harqProcessId);
1088 auto itHarq = harqDlInfoMap.find(tbId.
m_rnti);
1089 if (itHarq == harqDlInfoMap.end())
1095 if ((*itTb).second.corrupt)
1099 << (uint16_t)(*itTb).second.harqProcessId <<
" layer "
1100 << (uint16_t)tbId.
m_layer <<
" send DL-HARQ-NACK");
1102 (*itTb).second.harqProcessId,
1105 (*itTb).second.size,
1112 << (uint16_t)(*itTb).second.harqProcessId <<
" layer "
1113 << (uint16_t)tbId.
m_layer <<
" size "
1114 << (*itTb).second.size <<
" send DL-HARQ-ACK");
1115 m_harqPhyModule->ResetDlHarqProcessStatus((*itTb).second.harqProcessId);
1117 harqDlInfoMap.insert(
1118 std::pair<uint16_t, DlInfoListElement_s>(tbId.
m_rnti, harqDlInfo));
1122 if ((*itTb).second.corrupt)
1126 << (uint16_t)(*itTb).second.harqProcessId <<
" layer "
1127 << (uint16_t)tbId.
m_layer <<
" size "
1128 << (*itHarq).second.m_harqStatus.size()
1129 <<
" send DL-HARQ-NACK");
1131 (*itTb).second.harqProcessId,
1134 (*itTb).second.size,
1140 " layer " << (uint16_t)tbId.
m_layer);
1143 << (uint16_t)(*itTb).second.harqProcessId <<
" layer "
1144 << (uint16_t)tbId.
m_layer <<
" size "
1145 << (*itHarq).second.m_harqStatus.size()
1146 <<
" send DL-HARQ-ACK");
1147 m_harqPhyModule->ResetDlHarqProcessStatus((*itTb).second.harqProcessId);
1155 for (
auto itHarq = harqDlInfoMap.begin(); itHarq != harqDlInfoMap.end(); itHarq++)
1201 error = !(
m_random->GetValue() > errorRate);
1202 NS_LOG_DEBUG(
this <<
" PCFICH-PDCCH Decodification, errorRate " << errorRate <<
" error "
1288 "TransmissionMode not available: 1.." <<
m_txModeGain.size());
1296 NS_LOG_FUNCTION(
this <<
" txmode " << (uint16_t)txMode <<
" gain " << gain);
1300 double gainLin = std::pow(10.0, (gain / 10.0));
This class can be used to hold variables of floating point type such as 'double' or 'float'.
static TbStats_t GetTbDecodificationStats(const SpectrumValue &sinr, const std::vector< int > &map, uint16_t size, uint8_t mcs, HarqProcessInfoList_t miHistory)
run the error-model algorithm for the specified TB
static double GetPcfichPdcchError(const SpectrumValue &sinr)
run the error-model algorithm for the specified PCFICH+PDCCH channels
Tag used to define the RNTI and LC id for each MAC packet transmitted.
uint16_t GetRnti() const
Get RNTI function.
uint8_t GetLayer() const
Get layer function.
The LteSpectrumPhy models the physical layer of LTE.
void RemoveExpectedTb(uint16_t rnti)
Remove expected transport block.
Ptr< const SpectrumModel > m_rxSpectrumModel
the spectrum model
TracedCallback< Ptr< const PacketBurst > > m_phyTxEndTrace
the phy transmit end trace callback
bool m_dataErrorModelEnabled
when true (default) the phy error model is enabled
void SetState(State newState)
Set the state of the phy layer.
Ptr< LteInterference > m_interferenceData
the data interference
uint8_t m_transmissionMode
for UEs: store the transmission mode
EventId m_endRxDlCtrlEvent
end receive DL control event
void AddCtrlSinrChunkProcessor(Ptr< LteChunkProcessor > p)
void AddDataSinrChunkProcessor(Ptr< LteChunkProcessor > p)
LtePhyUlHarqFeedbackCallback m_ltePhyUlHarqFeedbackCallback
the LTE phy UL HARQ feedback callback
void AddExpectedTb(uint16_t rnti, uint8_t ndi, uint16_t size, uint8_t mcs, std::vector< int > map, uint8_t layer, uint8_t harqId, uint8_t rv, bool downlink)
Ptr< MobilityModel > GetMobility() const override
Get the associated MobilityModel instance.
Ptr< const SpectrumModel > GetRxSpectrumModel() const override
void SetHarqPhyModule(Ptr< LteHarqPhy > harq)
Set HARQ phy function.
LtePhyRxPssCallback m_ltePhyRxPssCallback
the LTE phy receive PSS callback
void StartRxDlCtrl(Ptr< LteSpectrumSignalParametersDlCtrlFrame > lteDlCtrlRxParams)
Start receive DL control function.
void StartRxUlSrs(Ptr< LteSpectrumSignalParametersUlSrsFrame > lteUlSrsRxParams)
Start receive UL SRS function.
void AddDataPowerChunkProcessor(Ptr< LteChunkProcessor > p)
EventId m_endRxDataEvent
end receive data event
void SetLtePhyRxPssCallback(LtePhyRxPssCallback c)
set the callback for the reception of the PSS as part of the interconnections between the LteSpectrum...
void SetAntenna(Ptr< AntennaModel > a)
set the AntennaModel to be used
bool StartTxDataFrame(Ptr< PacketBurst > pb, std::list< Ptr< LteControlMessage > > ctrlMsgList, Time duration)
Start a transmission of data frame in DL and UL.
void StartRxData(Ptr< LteSpectrumSignalParametersDataFrame > params)
Start receive data function.
TracedCallback< PhyReceptionStatParameters > m_dlPhyReception
Trace information regarding PHY stats from DL Rx perspective PhyReceptionStatParameters (see lte-comm...
Ptr< NetDevice > m_device
the device
Ptr< SpectrumChannel > GetChannel()
TracedCallback< Ptr< const PacketBurst > > m_phyTxStartTrace
the phy transmit start trace callback
void DoDispose() override
Destructor implementation.
void EndTxData()
End transmit data function.
void SetTransmissionMode(uint8_t txMode)
void SetLtePhyRxDataEndErrorCallback(LtePhyRxDataEndErrorCallback c)
set the callback for the end of a RX in error, as part of the interconnections between the PHY and th...
SpectrumValue m_sinrPerceived
the preceived SINR
Ptr< SpectrumValue > m_txPsd
the transmit PSD
void AddInterferenceDataChunkProcessor(Ptr< LteChunkProcessor > p)
LteChunkProcessor devoted to evaluate interference + noise power in data symbols of the subframe.
void SetDevice(Ptr< NetDevice > d) override
Set the associated NetDevice instance.
void ChangeState(State newState)
Change state function.
void SetTxModeGain(uint8_t txMode, double gain)
Set transmit mode gain function.
std::vector< double > m_txModeGain
duplicate value of LteUePhy
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Ptr< NetDevice > GetDevice() const override
Get the associated NetDevice instance.
Time m_firstRxStart
the first receive start
Ptr< LteHarqPhy > m_harqPhyModule
the HARQ phy module
void SetLtePhyRxDataEndOkCallback(LtePhyRxDataEndOkCallback c)
set the callback for the successful end of a RX, as part of the interconnections between the PHY and ...
void EndRxUlSrs()
End receive UL SRS function.
void SetLtePhyUlHarqFeedbackCallback(LtePhyUlHarqFeedbackCallback c)
set the callback for the UL HARQ feedback as part of the interconnections between the LteSpectrumPhy ...
void SetChannel(Ptr< SpectrumChannel > c) override
Set the channel attached to this device.
void SetComponentCarrierId(uint8_t componentCarrierId)
TracedCallback< Ptr< const PacketBurst > > m_phyRxStartTrace
the phy receive start trace callback
expectedTbs_t m_expectedTbs
the expected TBS
void EndTxUlSrs()
End transmit UL SRS function.
void SetNoisePowerSpectralDensity(Ptr< const SpectrumValue > noisePsd)
set the noise power spectral density
void UpdateSinrPerceived(const SpectrumValue &sinr)
Ptr< SpectrumChannel > m_channel
the channel
void EndRxDlCtrl()
End receive DL control function.
void SetTxPowerSpectralDensity(Ptr< SpectrumValue > txPsd)
set the Power Spectral Density of outgoing signals in W/Hz.
EventId m_endTxEvent
end transmit event
LtePhyRxDataEndOkCallback m_ltePhyRxDataEndOkCallback
the LTE phy receive data end ok callback
void SetLtePhyRxCtrlEndErrorCallback(LtePhyRxCtrlEndErrorCallback c)
set the callback for the erroneous end of a RX ctrl frame, as part of the interconnections between th...
uint16_t m_cellId
the cell ID
Ptr< AntennaModel > m_antenna
the antenna model
void SetLtePhyDlHarqFeedbackCallback(LtePhyDlHarqFeedbackCallback c)
set the callback for the DL HARQ feedback as part of the interconnections between the LteSpectrumPhy ...
Time m_firstRxDuration
the first receive duration
Ptr< PacketBurst > m_txPacketBurst
the transmit packet burst
uint8_t m_componentCarrierId
the component carrier ID
void StartRx(Ptr< SpectrumSignalParameters > params) override
Notify the SpectrumPhy instance of an incoming signal.
Ptr< Object > GetAntenna() const override
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.
LtePhyRxDataEndErrorCallback m_ltePhyRxDataEndErrorCallback
the LTE phy receive data end error callback
bool StartTxDlCtrlFrame(std::list< Ptr< LteControlMessage > > ctrlMsgList, bool pss)
Start a transmission of control frame in DL.
static TypeId GetTypeId()
Get the type ID.
uint8_t m_layersNum
layers num
Ptr< MobilityModel > m_mobility
the modility model
~LteSpectrumPhy() override
TracedCallback< PhyReceptionStatParameters > m_ulPhyReception
Trace information regarding PHY stats from UL Rx perspective PhyReceptionStatParameters (see lte-comm...
void SetMobility(Ptr< MobilityModel > m) override
Set the mobility model associated with this device.
LtePhyDlHarqFeedbackCallback m_ltePhyDlHarqFeedbackCallback
the LTE phy DL HARQ feedback callback
void EndTxDlCtrl()
End transmit DL control function.
std::list< Ptr< LteControlMessage > > m_rxControlMessageList
the receive control message list
void AddRsPowerChunkProcessor(Ptr< LteChunkProcessor > p)
Ptr< LteInterference > m_interferenceCtrl
the control interference
TracedCallback< Ptr< const Packet > > m_phyRxEndErrorTrace
the phy receive end error trace callback
void EndRxData()
End receive data function.
std::list< Ptr< LteControlMessage > > m_txControlMessageList
the transmit control message list
bool m_ctrlErrorModelEnabled
when true (default) the phy error model is enabled for DL ctrl frame
std::list< Ptr< PacketBurst > > m_rxPacketBurstList
the receive burst list
void AddInterferenceCtrlChunkProcessor(Ptr< LteChunkProcessor > p)
LteChunkProcessor devoted to evaluate interference + noise power in control symbols of the subframe.
TracedCallback< Ptr< const Packet > > m_phyRxEndOkTrace
the phy receive end ok trace callback
bool StartTxUlSrsFrame()
Start a transmission of control frame in UL.
LtePhyRxCtrlEndErrorCallback m_ltePhyRxCtrlEndErrorCallback
the LTE phy receive control end error callback
void SetLtePhyRxCtrlEndOkCallback(LtePhyRxCtrlEndOkCallback c)
set the callback for the successful end of a RX ctrl frame, as part of the interconnections between t...
void Reset()
reset the internal state
EventId m_endRxUlSrsEvent
end receive UL SRS event
void SetCellId(uint16_t cellId)
LtePhyRxCtrlEndOkCallback m_ltePhyRxCtrlEndOkCallback
the LTE phy receive control end ok callback
Ptr< UniformRandomVariable > m_random
Provides uniform random variables.
Ptr< T > GetObject() const
Get a pointer to the requested aggregated Object.
virtual void DoDispose()
Destructor implementation.
Smart pointer class similar to boost::intrusive_ptr.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static Time Now()
Return the current simulation virtual time.
Set of values corresponding to a given SpectrumModel.
Simulation virtual time values and global simulation resolution.
int64_t GetMilliSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
static uint8_t TxMode2LayerNum(uint8_t txMode)
Transmit mode 2 layer number.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Callback< R, Args... > MakeNullCallback()
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Ptr< T > Create(Ts &&... args)
Create class instances by constructors with varying numbers of arguments and return them by Ptr.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeBooleanChecker()
Callback< void, Ptr< Packet > > LtePhyRxDataEndOkCallback
This method is used by the LteSpectrumPhy to notify the PHY that a previously started RX attempt has ...
Callback< void, uint16_t, Ptr< SpectrumValue > > LtePhyRxPssCallback
This method is used by the LteSpectrumPhy to notify the UE PHY that a PSS has been received.
bool operator==(const EventId &a, const EventId &b)
Callback< void > LtePhyRxDataEndErrorCallback
This method is used by the LteSpectrumPhy to notify the PHY that a previously started RX attempt has ...
std::ostream & operator<<(std::ostream &os, const Angles &a)
Callback< void, std::list< Ptr< LteControlMessage > > > LtePhyRxCtrlEndOkCallback
This method is used by the LteSpectrumPhy to notify the PHY that a previously started RX of a control...
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
bool operator<(const EventId &a, const EventId &b)
std::vector< HarqProcessInfoElement_t > HarqProcessInfoList_t
HarqProcessInfoList_t typedef.
Callback< void, DlInfoListElement_s > LtePhyDlHarqFeedbackCallback
This method is used by the LteSpectrumPhy to notify the PHY about the status of a certain DL HARQ pro...
Callback< void > LtePhyRxCtrlEndErrorCallback
This method is used by the LteSpectrumPhy to notify the PHY that a previously started RX of a control...
static const Time DL_CTRL_DURATION
duration of the control portion of a subframe = 0.001 / 14 * 3 (ctrl fixed to 3 symbols) -1ns as marg...
Callback< void, UlInfoListElement_s > LtePhyUlHarqFeedbackCallback
This method is used by the LteSpectrumPhy to notify the PHY about the status of a certain UL HARQ pro...
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
static const Time UL_SRS_DURATION
duration of SRS portion of UL subframe = 1 symbol for SRS -1ns as margin to avoid overlapping simulat...
static const double EffectiveCodingRate[29]
Effective coding rate.
See section 4.3.23 dlInfoListElement.
uint8_t m_harqProcessId
HARQ process ID.
std::vector< HarqStatus_e > m_harqStatus
HARQ status.
PhyReceptionStatParameters structure.
double mi
Mutual information.
double tbler
Transport block BLER.
See section 4.3.12 ulInfoListElement.
uint8_t m_tpc
Tx power control command.