lte-enb-phy.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
 *
 * 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: Giuseppe Piro  <g.piro@poliba.it>
 * Author: Marco Miozzo <marco.miozzo@cttc.es>
 */

#ifndef ENB_LTE_PHY_H
#define ENB_LTE_PHY_H


#include <ns3/lte-control-messages.h>
#include <ns3/lte-enb-phy-sap.h>
#include <ns3/lte-enb-cphy-sap.h>
#include <ns3/lte-phy.h>
#include <ns3/lte-harq-phy.h>

#include <map>
#include <set>



namespace ns3 {

class PacketBurst;
class LteNetDevice;
class LteUePhy;

class LteEnbPhy : public LtePhy
{
  friend class EnbMemberLteEnbPhySapProvider;
  friend class MemberLteEnbCphySapProvider<LteEnbPhy>;

public:
  LteEnbPhy ();

  LteEnbPhy (Ptr<LteSpectrumPhy> dlPhy, Ptr<LteSpectrumPhy> ulPhy);

  virtual ~LteEnbPhy ();

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


  LteEnbPhySapProvider* GetLteEnbPhySapProvider ();

  void SetLteEnbPhySapUser (LteEnbPhySapUser* s);

  LteEnbCphySapProvider* GetLteEnbCphySapProvider ();

  void SetLteEnbCphySapUser (LteEnbCphySapUser* s);

  void SetTxPower (double pow);

  double GetTxPower () const;

  int8_t DoGetReferenceSignalPower () const;

  void SetNoiseFigure (double pow);

  double GetNoiseFigure () const;

  void SetMacChDelay (uint8_t delay);

  uint8_t GetMacChDelay (void) const;

  Ptr<LteSpectrumPhy> GetDlSpectrumPhy () const;

  Ptr<LteSpectrumPhy> GetUlSpectrumPhy () const;


  void SetDownlinkSubChannels (std::vector<int> mask );

  void SetDownlinkSubChannelsWithPowerAllocation (std::vector<int> mask);
  std::vector<int> GetDownlinkSubChannels (void);


  void GeneratePowerAllocationMap (uint16_t rnti, int rbId);

  virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensity ();

  virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensityWithPowerAllocation ();

  void CalcChannelQualityForUe (std::vector <double> sinr, Ptr<LteSpectrumPhy> ue);

  virtual void ReceiveLteControlMessage (Ptr<LteControlMessage> msg);

  FfMacSchedSapProvider::SchedUlCqiInfoReqParameters CreatePuschCqiReport (const SpectrumValue& sinr);

  FfMacSchedSapProvider::SchedUlCqiInfoReqParameters CreateSrsCqiReport (const SpectrumValue& sinr);

  void SendControlChannels (std::list<Ptr<LteControlMessage> > ctrlMsgList);

  void SendDataChannels (Ptr<PacketBurst> pb);

  void QueueUlDci (UlDciLteControlMessage m);

  std::list<UlDciLteControlMessage> DequeueUlDci (void);


  void StartFrame (void);
  void StartSubFrame (void);
  void EndSubFrame (void);
  void EndFrame (void);

  void PhyPduReceived (Ptr<Packet> p);

  virtual void ReceiveLteControlMessageList (std::list<Ptr<LteControlMessage> >);

  // inherited from LtePhy
  virtual void GenerateCtrlCqiReport (const SpectrumValue& sinr);
  virtual void GenerateDataCqiReport (const SpectrumValue& sinr);
  virtual void ReportInterference (const SpectrumValue& interf);
  virtual void ReportRsReceivedPower (const SpectrumValue& power);



  virtual void ReceiveLteUlHarqFeedback (UlInfoListElement_s mes);

  void SetHarqPhyModule (Ptr<LteHarqPhy> harq);

  typedef void (* ReportUeSinrTracedCallback)
    (const uint16_t cellId, const uint16_t rnti, const double sinrLinear);

  typedef void (* ReportInterferenceTracedCallback)
    (const uint16_t cellId, const Ptr<const SpectrumValue> spectrumValue);


private:

  // LteEnbCphySapProvider forwarded methods
  void DoSetBandwidth (uint8_t ulBandwidth, uint8_t dlBandwidth);
  void DoSetEarfcn (uint16_t dlEarfcn, uint16_t ulEarfcn);
  void DoAddUe (uint16_t rnti);
  void DoRemoveUe (uint16_t rnti);
  void DoSetPa (uint16_t rnti, double pa);
  void DoSetTransmissionMode (uint16_t  rnti, uint8_t txMode);
  void DoSetSrsConfigurationIndex (uint16_t  rnti, uint16_t srcCi);
  void DoSetMasterInformationBlock (LteRrcSap::MasterInformationBlock mib);
  void DoSetSystemInformationBlockType1 (LteRrcSap::SystemInformationBlockType1 sib1);

  // LteEnbPhySapProvider forwarded methods
  void DoSendMacPdu (Ptr<Packet> p);
  void DoSendLteControlMessage (Ptr<LteControlMessage> msg);
  uint8_t DoGetMacChTtiDelay ();

  bool AddUePhy (uint16_t rnti);
  bool DeleteUePhy (uint16_t rnti);

  void CreateSrsReport (uint16_t rnti, double srs);

  std::set <uint16_t> m_ueAttached;


  std::map <uint16_t,double> m_paMap;

  std::map <int, double> m_dlPowerAllocationMap;

  std::vector <int> m_listOfDownlinkSubchannel;

  std::vector <int> m_dlDataRbMap;

  std::vector< std::list<UlDciLteControlMessage> > m_ulDciQueue;

  LteEnbPhySapProvider* m_enbPhySapProvider;
  LteEnbPhySapUser* m_enbPhySapUser;

  LteEnbCphySapProvider* m_enbCphySapProvider;
  LteEnbCphySapUser* m_enbCphySapUser;

  uint32_t m_nrFrames;
  uint32_t m_nrSubFrames;

  uint16_t m_srsPeriodicity;
  Time m_srsStartTime;
  std::map <uint16_t,uint16_t> m_srsCounter;
  std::vector <uint16_t> m_srsUeOffset;
  uint16_t m_currentSrsOffset;

  LteRrcSap::MasterInformationBlock m_mib;
  LteRrcSap::SystemInformationBlockType1 m_sib1;

  Ptr<LteHarqPhy> m_harqPhyModule;

  TracedCallback<uint16_t, uint16_t, double> m_reportUeSinr;
  uint16_t m_srsSamplePeriod;
  std::map <uint16_t,uint16_t> m_srsSampleCounterMap;

  TracedCallback<uint16_t, Ptr<SpectrumValue> > m_reportInterferenceTrace;
  uint16_t m_interferenceSamplePeriod;
  uint16_t m_interferenceSampleCounter;

  TracedCallback<PhyTransmissionStatParameters> m_dlPhyTransmission;

}; // end of `class LteEnbPhy`


}

#endif /* LTE_ENB_PHY_H */