lte-enb-rrc.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 * Modified by: Marco Miozzo <mmiozzo@cttc.es> 
 *                add transmission Mode and SRS related functionalities
 */

#ifndef LTE_ENB_RRC_H
#define LTE_ENB_RRC_H

#include <ns3/object.h>
#include <ns3/packet.h>
#include <ns3/lte-enb-cmac-sap.h>
#include <ns3/ff-mac-common.h>
#include <ns3/lte-pdcp-sap.h>

#include <map>
#include <set>

namespace ns3 {

class FfMacSchedSapProvider;
class LteMacSapProvider;
class LteRadioBearerInfo;
class LtePdcpSapUser;
class LtePdcpSapProvider;


class UeInfo : public Object
{
public:
  uint8_t AddRadioBearer (Ptr<LteRadioBearerInfo> radioBearerInfo);

  Ptr<LteRadioBearerInfo> GetRadioBearer (uint8_t lcid);


  void RemoveRadioBearer (uint8_t lcid);

  UeInfo (void);
  UeInfo (uint64_t imsi);
  UeInfo (uint64_t imsi, uint16_t srsConfIndex);
  virtual ~UeInfo (void);

  static TypeId GetTypeId (void);

  uint64_t GetImsi (void);
  uint16_t GetSrsConfigurationIndex (void);
  uint8_t GetTransmissionMode (void);
  void SetSrsConfigurationIndex (uint16_t srsConfIndex);
  void SetTransmissionMode (uint8_t txMode);

private:
  std::map <uint8_t, Ptr<LteRadioBearerInfo> > m_rbMap;
  uint8_t m_lastAllocatedId;
  uint64_t m_imsi;
  uint16_t m_srsConfigurationIndex;
  uint8_t  m_transmissionMode;
};


class LteEnbRrc : public Object
{

  friend class EnbRrcMemberLteEnbCmacSapUser;
  friend class LtePdcpSpecificLtePdcpSapUser<LteEnbRrc>;

public:
  LteEnbRrc ();

  virtual ~LteEnbRrc ();


  // inherited from Object
  virtual void DoDispose (void);
  static TypeId GetTypeId (void);


  void SetLteEnbCmacSapProvider (LteEnbCmacSapProvider * s);

  LteEnbCmacSapUser* GetLteEnbCmacSapUser ();


  void SetFfMacSchedSapProvider (FfMacSchedSapProvider* s);


  void SetLteMacSapProvider (LteMacSapProvider* s);



  void ConfigureCell (uint8_t ulBandwidth,
                      uint8_t dlBandwidth);

  uint16_t AddUe (uint64_t imsi);
  
  void SetCellId (uint16_t m_cellId);

  void RemoveUe (uint16_t rnti);

  uint16_t GetLastAllocatedRnti () const;
  void SetLastAllocatedRnti (uint16_t lastAllocatedRnti);
  void SetUeMap (std::map<uint16_t,Ptr<UeInfo> > ueMap);
  std::map<uint16_t,Ptr<UeInfo> > GetUeMap (void) const;

  uint8_t SetupRadioBearer (uint16_t rnti, EpsBearer bearer, TypeId rlcTypeId);


  void ReleaseRadioBearer (uint16_t rnti, uint8_t lcId);

  
  bool Send (Ptr<Packet> p);

  void SetForwardUpCallback (Callback <void, Ptr<Packet> > cb);
  
  void ConfigureNewUe (uint16_t rnti);
  
  
private:

  void DoReceiveRrcPdu (LtePdcpSapUser::ReceiveRrcPduParameters params);
  void DoRrcConfigurationUpdateInd (LteUeConfig_t params);
  void SendUeConfigurationUpdate (LteUeConfig_t params);
  
  void DoNotifyLcConfigResult (uint16_t rnti, uint8_t lcid, bool success);
  LtePdcpSapProvider* GetLtePdcpSapProvider (uint16_t rnti, uint8_t lcid);

  // management of multiple UE info instances
  uint16_t CreateUeInfo (uint64_t imsi);
  Ptr<UeInfo> GetUeInfo (uint16_t rnti);
  void RemoveUeInfo (uint16_t rnti);
  uint16_t GetNewSrsConfigurationIndex (void);
  void RemoveSrsConfigurationIndex (uint16_t srcCi);

  Callback <void, Ptr<Packet> > m_forwardUpCallback;

  LteEnbCmacSapUser* m_cmacSapUser;
  LteEnbCmacSapProvider* m_cmacSapProvider;

  FfMacSchedSapProvider* m_ffMacSchedSapProvider;
  LteMacSapProvider* m_macSapProvider;
  LtePdcpSapUser* m_pdcpSapUser;

  bool m_configured;
  uint16_t m_lastAllocatedRnti;

  std::map<uint16_t, Ptr<UeInfo> > m_ueMap;  
  
  uint8_t m_defaultTransmissionMode;
  
  uint16_t m_cellId;
  
  // SRS related attributes
  uint16_t m_srsCurrentPeriodicityId;
  std::set<uint16_t> m_ueSrsConfigurationIndexSet;
  uint16_t m_lastAllocatedConfigurationIndex;
  bool m_reconfigureUes;

};


} // namespace ns3

#endif // LTE_ENB_RRC_H