cc-helper.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Danilo Abrignani
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
 */
 
#include "cc-helper.h"
 
#include <ns3/abort.h>
#include <ns3/component-carrier.h>
#include <ns3/log.h>
#include <ns3/lte-spectrum-value-helper.h>
#include <ns3/pointer.h>
#include <ns3/string.h>
#include <ns3/uinteger.h>
 
#include <iostream>
 
#define MIN_CC 1
#define MAX_CC 2
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("CcHelper");
 
NS_OBJECT_ENSURE_REGISTERED(CcHelper);
 
CcHelper::CcHelper()
{
    NS_LOG_FUNCTION(this);
    m_ccFactory.SetTypeId(ComponentCarrier::GetTypeId());
}
 
void
CcHelper::DoInitialize()
{
    NS_LOG_FUNCTION(this);
}
 
TypeId
CcHelper::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::CcHelper")
            .SetParent<Object>()
            .AddConstructor<CcHelper>()
            .AddAttribute("NumberOfComponentCarriers",
                          "Set the number of Component Carriers to setup per eNodeB"
                          "Currently the maximum Number of Component Carriers allowed is 2",
                          UintegerValue(1),
                          MakeUintegerAccessor(&CcHelper::m_numberOfComponentCarriers),
                          MakeUintegerChecker<uint16_t>(MIN_CC, MAX_CC))
            .AddAttribute("UlEarfcn",
                          "Set Ul Channel [EARFCN] for the first carrier component",
                          UintegerValue(0),
                          MakeUintegerAccessor(&CcHelper::m_ulEarfcn),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("DlEarfcn",
                          "Set Dl Channel [EARFCN] for the first carrier component",
                          UintegerValue(0),
                          MakeUintegerAccessor(&CcHelper::m_dlEarfcn),
                          MakeUintegerChecker<uint32_t>(0))
            .AddAttribute("DlBandwidth",
                          "Set Dl Bandwidth for the first carrier component",
                          UintegerValue(25),
                          MakeUintegerAccessor(&CcHelper::m_dlBandwidth),
                          MakeUintegerChecker<uint16_t>(0, 100))
            .AddAttribute("UlBandwidth",
                          "Set Dl Bandwidth for the first carrier component",
                          UintegerValue(25),
                          MakeUintegerAccessor(&CcHelper::m_ulBandwidth),
                          MakeUintegerChecker<uint16_t>(0, 100));
 
    return tid;
}
 
CcHelper::~CcHelper()
{
    NS_LOG_FUNCTION(this);
}
 
void
CcHelper::DoDispose()
{
    NS_LOG_FUNCTION(this);
    Object::DoDispose();
}
 
void
CcHelper::SetCcAttribute(std::string n, const AttributeValue& v)
{
    NS_LOG_FUNCTION(this << n);
    m_ccFactory.Set(n, v);
}
 
void
CcHelper::SetNumberOfComponentCarriers(uint16_t nCc)
{
    m_numberOfComponentCarriers = nCc;
}
 
void
CcHelper::SetUlEarfcn(uint32_t ulEarfcn)
{
    m_ulEarfcn = ulEarfcn;
}
 
void
CcHelper::SetDlEarfcn(uint32_t dlEarfcn)
{
    m_dlEarfcn = dlEarfcn;
}
 
void
CcHelper::SetDlBandwidth(uint16_t dlBandwidth)
{
    m_dlBandwidth = dlBandwidth;
}
 
void
CcHelper::SetUlBandwidth(uint16_t ulBandwidth)
{
    m_ulBandwidth = ulBandwidth;
}
 
uint16_t
CcHelper::GetNumberOfComponentCarriers() const
{
    return m_numberOfComponentCarriers;
}
 
uint32_t
CcHelper::GetUlEarfcn() const
{
    return m_ulEarfcn;
}
 
uint32_t
CcHelper::GetDlEarfcn() const
{
    return m_dlEarfcn;
}
 
uint16_t
CcHelper::GetDlBandwidth() const
{
    return m_dlBandwidth;
}
 
uint16_t
CcHelper::GetUlBandwidth() const
{
    return m_ulBandwidth;
}
 
ComponentCarrier
CcHelper::DoCreateSingleCc(uint16_t ulBandwidth,
                           uint16_t dlBandwidth,
                           uint32_t ulEarfcn,
                           uint32_t dlEarfcn,
                           bool isPrimary)
{
    return CreateSingleCc(ulBandwidth, dlBandwidth, ulEarfcn, dlEarfcn, isPrimary);
}
 
std::map<uint8_t, ComponentCarrier>
CcHelper::EquallySpacedCcs()
{
    std::map<uint8_t, ComponentCarrier> ccmap;
 
    uint32_t ulEarfcn = m_ulEarfcn;
    uint32_t dlEarfcn = m_dlEarfcn;
    uint16_t maxBandwidthRb = std::max<uint16_t>(m_ulBandwidth, m_dlBandwidth);
 
    // Convert bandwidth from RBs to kHz
    uint32_t maxBandwidthKhz = LteSpectrumValueHelper::GetChannelBandwidth(maxBandwidthRb) / 1e3;
 
    for (uint16_t i = 0; i < m_numberOfComponentCarriers; i++)
    {
        // Make sure we stay within the same band.
        if (LteSpectrumValueHelper::GetUplinkCarrierBand(ulEarfcn) !=
                LteSpectrumValueHelper::GetUplinkCarrierBand(m_ulEarfcn) ||
            LteSpectrumValueHelper::GetDownlinkCarrierBand(dlEarfcn) !=
                LteSpectrumValueHelper::GetDownlinkCarrierBand(m_dlEarfcn))
        {
            NS_FATAL_ERROR("Band is not wide enough to allocate " << +m_numberOfComponentCarriers
                                                                  << " CCs");
        }
 
        bool pc = false;
 
        if (i == 0)
        {
            pc = true;
        }
        ComponentCarrier cc = CreateSingleCc(m_ulBandwidth, m_dlBandwidth, ulEarfcn, dlEarfcn, pc);
        ccmap.insert(std::pair<uint8_t, ComponentCarrier>(i, cc));
 
        NS_LOG_INFO("ulBandwidth: " << m_ulBandwidth << ", dlBandwidth: " << m_dlBandwidth
                                    << ", ulEarfcn: " << ulEarfcn << ", dlEarfcn: " << dlEarfcn);
 
        // The spacing between the centre frequencies of two contiguous CCs should be multiple of
        // 300 kHz. Round spacing up to 300 kHz.
        uint32_t frequencyShift = 300 * (1 + (maxBandwidthKhz - 1) / 300);
 
        // Unit of EARFCN corresponds to 100kHz.
        uint32_t earfcnShift = frequencyShift / 100;
        ulEarfcn += earfcnShift;
        dlEarfcn += earfcnShift;
    }
 
    return ccmap;
}
 
ComponentCarrier
CcHelper::CreateSingleCc(uint16_t ulBandwidth,
                         uint16_t dlBandwidth,
                         uint32_t ulEarfcn,
                         uint32_t dlEarfcn,
                         bool isPrimary) const
{
    ComponentCarrier cc;
    if (m_ulEarfcn != 0)
    {
        cc.SetUlEarfcn(ulEarfcn);
    }
    else
    {
        uint16_t ul = cc.GetUlEarfcn() + ulEarfcn;
        cc.SetUlEarfcn(ul);
    }
    if (m_dlEarfcn != 0)
    {
        cc.SetDlEarfcn(dlEarfcn);
    }
    else
    {
        uint16_t dl = cc.GetDlEarfcn() + dlEarfcn;
        cc.SetDlEarfcn(dl);
    }
    cc.SetDlBandwidth(dlBandwidth);
    cc.SetUlBandwidth(ulBandwidth);
 
    cc.SetAsPrimary(isPrimary);
 
    return cc;
}
 
} // namespace ns3