lte-enb-component-carrier-manager.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2015 Danilo Abrignani
 *
 * 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: Danilo Abrignani <danilo.abrignani@unibo.it>
 *
 */

#ifndef LTE_ENB_COMPONENT_CARRIER_MANAGER_H
#define LTE_ENB_COMPONENT_CARRIER_MANAGER_H

#include <ns3/object.h>
#include <ns3/lte-enb-rrc.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/lte-ccm-rrc-sap.h>
#include <ns3/lte-mac-sap.h>
#include <ns3/lte-enb-cmac-sap.h>
#include <ns3/lte-ccm-mac-sap.h>
#include <map>
#include <vector>

namespace ns3 {


class LteCcmRrcSapUser;
class LteCcmRrcSapProvider;
class LteMacSapUser;
class LteMacSapProvider;
class LteEnbCmacSapProvider;
class LteCcmMacSapProvider;

class LteEnbComponentCarrierManager : public Object
{
public:

  LteEnbComponentCarrierManager ();
  virtual ~LteEnbComponentCarrierManager ();
  static TypeId GetTypeId ();

  virtual void SetLteCcmRrcSapUser (LteCcmRrcSapUser* s);

  virtual LteCcmRrcSapProvider* GetLteCcmRrcSapProvider ();

  virtual LteCcmMacSapUser* GetLteCcmMacSapUser ();

  virtual LteMacSapProvider* GetLteMacSapProvider ();

  virtual bool SetMacSapProvider (uint8_t componentCarrierId, LteMacSapProvider* sap);

  virtual bool SetCcmMacSapProviders (uint8_t componentCarrierId, LteCcmMacSapProvider* sap);

  virtual void SetNumberOfComponentCarriers (uint16_t noOfComponentCarriers);

  virtual void SetRrc (const Ptr<LteEnbRrc> rrc);

protected:

  // inherited from Object
  virtual void DoDispose ();

  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) = 0;

  std::map <uint16_t, std::map<uint8_t, LteMacSapUser*> > m_ueAttached;
  std::map <uint16_t, std::map<uint8_t, LteEnbCmacSapProvider::LcInfo> > m_rlcLcInstantiated; 
  std::map <uint16_t, uint8_t> m_enabledComponentCarrier; 
  std::map <uint16_t, uint8_t> m_ueState; 
  uint16_t m_noOfComponentCarriers; 
  // pointer to RRC object for direct function calls, e.g. when CCM needs to obtain
  // a pointer to RLC object of a specific flow
  Ptr<LteEnbRrc> m_rrc; 

  /*
   * This interface is used to receive API calls from the RLC instance that through
   * LteMacSapProvider interface. The component carrier manager acts a proxy. This means that all
   * RLC instances will see as in previous architecture the LteMacSapProvider interface, but the
   * actual provider in new architecture will be some of child classes of LteEnbComponentCarrierManager.
   * So, LteEnbComponentCarrierManager class will receive function calls that are meant for MAC, and
   * will forward them to the MAC of the component carriers based on the logic implemented
   * in LteComponentCarrierManager. This attribute will be initialized by using class that implements
   * LteMacSapProvider interface and class that implements LteEnbComponentCarrierManager base class
   * e.g.:EnbMacMemberLteMacSapProvider <LteEnbComponentCarrierManagerImpl>
   */
  LteMacSapProvider* m_macSapProvider;
  // This map is initialized in LteHelper when the Component Carrier Manager is initialized, contains
  // component carrier id and a pointer to the corresponding LteMacSapProvider interface of the
  // MAC instance
  std::map <uint8_t, LteMacSapProvider*> m_macSapProvidersMap; 
  // This map contains pointers to LteCcmMacSapProvider interfaces of the
  // MAC instances. LteCcmMacSapProvider is new interface added for the
  // communication between component carrier manager and MAC instance,
  // to allow CCM to control UL buffer status reporting, and forwarding to
  // schedulers. Before adding carrier aggregation to LTE module, MAC was
  // directly forwarding UL buffer status report to scheduler. Now is this
  // done through CCM, which decides to which MAC scheduler to forward UL BSR.
  std::map< uint8_t, LteCcmMacSapProvider*> m_ccmMacSapProviderMap; 
  LteCcmMacSapUser* m_ccmMacSapUser; 
  LteCcmRrcSapUser* m_ccmRrcSapUser; 
  LteCcmRrcSapProvider* m_ccmRrcSapProvider; 

}; // end of class LteEnbComponentCarrierManager


} // end of namespace ns3


#endif /* LTE_ENB_COMPONENT_CARRIER_MANAGER_H */