nr-common.cc

// Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Manuel Requena <manuel.requena@cttc.es>
// Author: Marco Miozzo <marco.miozzo@cttc.es>
 
#include "nr-common.h"
 
#include "ns3/abort.h"
#include "ns3/log.h"
 
namespace ns3
{
namespace nr
{
 
NS_LOG_COMPONENT_DEFINE("NrCommon");
 
FlowId_t::FlowId_t()
{
}
 
FlowId_t::FlowId_t(const uint16_t a, const uint8_t b)
    : m_rnti(a),
      m_lcId(b)
{
}
 
bool
operator==(const FlowId_t& a, const FlowId_t& b)
{
    return ((a.m_rnti == b.m_rnti) && (a.m_lcId == b.m_lcId));
}
 
bool
operator<(const FlowId_t& a, const FlowId_t& b)
{
    return ((a.m_rnti < b.m_rnti) || ((a.m_rnti == b.m_rnti) && (a.m_lcId < b.m_lcId)));
}
 
ImsiLcidPair_t::ImsiLcidPair_t()
{
}
 
ImsiLcidPair_t::ImsiLcidPair_t(const uint64_t a, const uint8_t b)
    : m_imsi(a),
      m_lcId(b)
{
}
 
bool
operator==(const ImsiLcidPair_t& a, const ImsiLcidPair_t& b)
{
    return ((a.m_imsi == b.m_imsi) && (a.m_lcId == b.m_lcId));
}
 
bool
operator<(const ImsiLcidPair_t& a, const ImsiLcidPair_t& b)
{
    return ((a.m_imsi < b.m_imsi) || ((a.m_imsi == b.m_imsi) && (a.m_lcId < b.m_lcId)));
}
 
NrUeConfig_t::NrUeConfig_t()
{
}
 
bool
operator==(const NrUeConfig_t& a, const NrUeConfig_t& b)
{
    return (a.m_rnti == b.m_rnti);
}
 
bool
operator<(const NrUeConfig_t& a, const NrUeConfig_t& b)
{
    return (a.m_rnti < b.m_rnti);
}
 
uint16_t
FfConverter::double2fpS11dot3(double val)
{
    // convert from double to fixed point notation Sxxxxxxxxxxx.xxx
    // truncate val to notation limits
    if (val > 4095.88)
    {
        val = 4095.88;
    }
    if (val < -4096)
    {
        val = -4096;
    }
    auto valFp = (int16_t)(val * 8);
    return valFp;
}
 
double
FfConverter::fpS11dot3toDouble(uint16_t val)
{
    // convert from fixed point notation Sxxxxxxxxxxx.xxx to double
    double valD = ((int16_t)val) / 8.0;
    return valD;
}
 
double
FfConverter::getMinFpS11dot3Value()
{
    return -4096; // -4096 = 0x8000 = 1000 0000 0000 0000 b
}
 
// static double g_lowestFpS11dot3Value = -4096; // 0x8001 (1000 0000 0000 0000)
 
static const uint32_t BufferSizeLevelBsrTable[64] = {
    0,     10,    12,    14,    17,    19,    22,    26,    31,     36,     42,     49,     57,
    67,    78,    91,    107,   125,   146,   171,   200,   234,    274,    321,    376,    440,
    515,   603,   706,   826,   967,   1132,  1326,  1552,  1817,   2127,   2490,   2915,   3413,
    3995,  4677,  5476,  6411,  7505,  8787,  10287, 12043, 14099,  16507,  19325,  22624,  26487,
    31009, 36304, 42502, 49759, 58255, 68201, 79846, 93749, 109439, 128125, 150000, 150000,
};
 
uint32_t
BufferSizeLevelBsr::BsrId2BufferSize(uint8_t val)
{
    NS_ABORT_MSG_UNLESS(val < 64, "val = " << val << " is out of range");
    return BufferSizeLevelBsrTable[val];
}
 
uint8_t
BufferSizeLevelBsr::BufferSize2BsrId(uint32_t val)
{
    int index = 0;
    if (BufferSizeLevelBsrTable[63] < val)
    {
        index = 63;
    }
    else
    {
        while (BufferSizeLevelBsrTable[index] < val)
        {
            NS_ASSERT(index < 64);
            index++;
        }
    }
 
    return index;
}
 
uint8_t
TransmissionModesLayers::TxMode2LayerNum(uint8_t txMode)
{
    uint8_t nLayer = 0;
    switch (txMode)
    {
    case 0: // Tx MODE 1: SISO
    case 1: // Tx MODE 2: MIMO Tx Diversity
        nLayer = 1;
        break;
    case 2: // Tx MODE 3: MIMO Spatial Multiplexity Open Loop
    case 3: // Tx MODE 4: MIMO Spatial Multiplexity Closed Loop
    case 4: // Tx MODE 5: MIMO Multi-User
        nLayer = 2;
        break;
    case 5: // Tx MODE 6: Closer loop single layer percoding
    case 6: // Tx MODE 7: Single antenna port 5
        nLayer = 1;
        break;
    }
    return nLayer;
}
 
double
EutranMeasurementMapping::RsrpRange2Dbm(uint8_t range)
{
    // 3GPP TS 36.133 section 9.1.4 RSRP Measurement Report Mapping
    NS_ASSERT_MSG(range <= 97, "value " << range << " is out of range");
    return (double)range - 141.0;
}
 
uint8_t
EutranMeasurementMapping::Dbm2RsrpRange(double dbm)
{
    // 3GPP TS 36.133 section 9.1.4 RSRP Measurement Report Mapping
    double range = std::min(std::max(std::floor(dbm + 141), 0.0), 97.0);
    return (uint8_t)range;
}
 
double
EutranMeasurementMapping::RsrqRange2Db(uint8_t range)
{
    // 3GPP TS 36.133 section 9.1.7 RSRQ Measurement Report Mapping
    NS_ASSERT_MSG(range <= 34, "value " << (uint16_t)range << " is out of range");
    return ((double)range - 40.0) * 0.5;
}
 
uint8_t
EutranMeasurementMapping::Db2RsrqRange(double db)
{
    // 3GPP TS 36.133 section 9.1.7 RSRQ Measurement Report Mapping
    double range = std::min(std::max(std::floor(db * 2 + 40), 0.0), 34.0);
    return (uint8_t)range;
}
 
double
EutranMeasurementMapping::QuantizeRsrp(double v)
{
    return RsrpRange2Dbm(Dbm2RsrpRange(v));
}
 
double
EutranMeasurementMapping::QuantizeRsrq(double v)
{
    return RsrqRange2Db(Db2RsrqRange(v));
}
 
double
EutranMeasurementMapping::IeValue2ActualHysteresis(uint8_t hysteresisIeValue)
{
    if (hysteresisIeValue > 30)
    {
        NS_FATAL_ERROR("The value " << (uint16_t)hysteresisIeValue
                                    << " is out of the allowed range (0..30)"
                                    << " for Hysteresis IE value");
    }
 
    double actual = static_cast<double>(hysteresisIeValue) * 0.5;
    NS_ASSERT(actual >= 0.0);
    NS_ASSERT(actual <= 15.0);
    return actual;
}
 
uint8_t
EutranMeasurementMapping::ActualHysteresis2IeValue(double hysteresisDb)
{
    if ((hysteresisDb < 0.0) || (hysteresisDb > 15.0))
    {
        NS_FATAL_ERROR("The value " << hysteresisDb << " is out of the allowed range (0..15) dB"
                                    << " for hysteresis");
    }
 
    uint8_t ieValue = lround(hysteresisDb * 2.0);
    NS_ASSERT(ieValue <= 30);
    return ieValue;
}
 
double
EutranMeasurementMapping::IeValue2ActualA3Offset(int8_t a3OffsetIeValue)
{
    if ((a3OffsetIeValue < -30) || (a3OffsetIeValue > 30))
    {
        NS_FATAL_ERROR("The value " << (int16_t)a3OffsetIeValue
                                    << " is out of the allowed range (-30..30)"
                                    << " for a3-Offset IE value");
    }
 
    double actual = static_cast<double>(a3OffsetIeValue) * 0.5;
    NS_ASSERT(actual >= -15.0);
    NS_ASSERT(actual <= 15.0);
    return actual;
}
 
int8_t
EutranMeasurementMapping::ActualA3Offset2IeValue(double a3OffsetDb)
{
    if ((a3OffsetDb < -15.0) || (a3OffsetDb > 15.0))
    {
        NS_FATAL_ERROR("The value " << a3OffsetDb << " is out of the allowed range (-15..15) dB"
                                    << " for A3 Offset");
    }
 
    int8_t ieValue = lround(a3OffsetDb * 2.0);
    NS_ASSERT(ieValue >= -30);
    NS_ASSERT(ieValue <= 30);
    return ieValue;
}
 
double
EutranMeasurementMapping::IeValue2ActualQRxLevMin(int8_t qRxLevMinIeValue)
{
    if ((qRxLevMinIeValue < -70) || (qRxLevMinIeValue > -22))
    {
        NS_FATAL_ERROR("The value " << (int16_t)qRxLevMinIeValue
                                    << " is out of the allowed range (-70..-22)"
                                    << " for Q-RxLevMin IE value");
    }
 
    double actual = static_cast<double>(qRxLevMinIeValue) * 2;
    NS_ASSERT(actual >= -140.0);
    NS_ASSERT(actual <= -44.0);
    return actual;
}
 
double
EutranMeasurementMapping::IeValue2ActualQQualMin(int8_t qQualMinIeValue)
{
    if ((qQualMinIeValue < -34) || (qQualMinIeValue > -3))
    {
        NS_FATAL_ERROR("The value " << (int16_t)qQualMinIeValue
                                    << " is out of the allowed range (-34..-3)"
                                    << " for Q-QualMin IE value");
    }
 
    auto actual = static_cast<double>(qQualMinIeValue);
    NS_ASSERT(actual >= -34.0);
    NS_ASSERT(actual <= -3.0);
    return actual;
}
}; // namespace nr
}; // namespace ns3