/* -*-  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>

 *         Nicola Baldo <nbaldo@cttc.es>

 *         Marco Miozzo <mmiozzo@cttc.es>

 */

#include "ns3/llc-snap-header.h"

#include "ns3/simulator.h"

#include "ns3/callback.h"

#include "ns3/node.h"

#include "ns3/packet.h"

#include "lte-net-device.h"

#include "ns3/packet-burst.h"

#include "ns3/uinteger.h"

#include "ns3/trace-source-accessor.h"

#include "ns3/pointer.h"

#include "ns3/enum.h"

#include "ns3/lte-enb-net-device.h"

#include "lte-ue-net-device.h"

#include "lte-ue-mac.h"

#include "lte-ue-rrc.h"

#include "ns3/ipv4-header.h"

#include "ns3/ipv4.h"

#include "lte-amc.h"

#include "lte-ue-phy.h"

#include "epc-ue-nas.h"

#include <ns3/ipv4-l3-protocol.h>

#include <ns3/log.h>

#include "epc-tft.h"

NS_OBJECT_ENSURE_REGISTERED ( LteUeNetDevice);

TypeId LteUeNetDevice::GetTypeId (void)

{

  static TypeId

    tid =

    TypeId ("ns3::LteUeNetDevice")

    .SetParent<LteNetDevice> ()

    .AddConstructor<LteUeNetDevice> ()

    .AddAttribute ("EpcUeNas",

                   "The NAS associated to this UeNetDevice",

                   PointerValue (),

                   MakePointerAccessor (&LteUeNetDevice::m_nas),

                   MakePointerChecker <EpcUeNas> ())

    .AddAttribute ("LteUeRrc",

                   "The RRC associated to this UeNetDevice",

                   PointerValue (),

                   MakePointerAccessor (&LteUeNetDevice::m_rrc),

                   MakePointerChecker <LteUeRrc> ())

    .AddAttribute ("LteUeMac",

                   "The MAC associated to this UeNetDevice",

                   PointerValue (),

                   MakePointerAccessor (&LteUeNetDevice::m_mac),

                   MakePointerChecker <LteUeMac> ())

    .AddAttribute ("LteUePhy",

                   "The PHY associated to this UeNetDevice",

                   PointerValue (),

                   MakePointerAccessor (&LteUeNetDevice::m_phy),

                   MakePointerChecker <LteUePhy> ())

    .AddAttribute ("Imsi",

                   "International Mobile Subscriber Identity assigned to this UE",

                   UintegerValue (0),

                   MakeUintegerAccessor (&LteUeNetDevice::m_imsi),

                   MakeUintegerChecker<uint64_t> ())

    .AddAttribute ("DlEarfcn",

                   "Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "

                   "as per 3GPP 36.101 Section 5.7.3. ",

                   UintegerValue (100),

                   MakeUintegerAccessor (&LteUeNetDevice::SetDlEarfcn,

                                         &LteUeNetDevice::GetDlEarfcn),

                   MakeUintegerChecker<uint16_t> (0, 6149))

    .AddAttribute ("CsgId",

                   "The Closed Subscriber Group (CSG) identity that this UE is associated with, "

                   "i.e., giving the UE access to cells which belong to this particular CSG. "

                   "This restriction only applies to initial cell selection and EPC-enabled simulation. "

                   "This does not revoke the UE's access to non-CSG cells. ",

                   UintegerValue (0),

                   MakeUintegerAccessor (&LteUeNetDevice::SetCsgId,

                                         &LteUeNetDevice::GetCsgId),

                   MakeUintegerChecker<uint32_t> ())

  ;

  return tid;

}

LteUeNetDevice::LteUeNetDevice (void)

  : m_isConstructed (false)

{

  NS_LOG_FUNCTION (this);

}

LteUeNetDevice::~LteUeNetDevice (void)

{

  NS_LOG_FUNCTION (this);

}

void

LteUeNetDevice::DoDispose (void)

{

  NS_LOG_FUNCTION (this);

  m_targetEnb = 0;

  m_mac->Dispose ();

  m_mac = 0;

  m_rrc->Dispose ();

  m_rrc = 0;

  m_phy->Dispose ();

  m_phy = 0;

  m_nas->Dispose ();

  m_nas = 0;

  LteNetDevice::DoDispose ();

}

void

LteUeNetDevice::UpdateConfig (void)

{

  NS_LOG_FUNCTION (this);

  if (m_isConstructed)

    {

      NS_LOG_LOGIC (this << " Updating configuration: IMSI " << m_imsi

                         << " CSG ID " << m_csgId);

      m_nas->SetImsi (m_imsi);

      m_rrc->SetImsi (m_imsi);

      m_nas->SetCsgId (m_csgId); // this also handles propagation to RRC

    }

  else

    {

      /*

       * NAS and RRC instances are not be ready yet, so do nothing now and

       * expect ``DoInitialize`` to re-invoke this function.

       */

    }

}

Ptr<LteUeMac>

LteUeNetDevice::GetMac (void) const

{

  NS_LOG_FUNCTION (this);

  return m_mac;

}

Ptr<LteUeRrc>

LteUeNetDevice::GetRrc (void) const

{

  NS_LOG_FUNCTION (this);

  return m_rrc;

}

Ptr<LteUePhy>

LteUeNetDevice::GetPhy (void) const

{

  NS_LOG_FUNCTION (this);

  return m_phy;

}

Ptr<EpcUeNas>

LteUeNetDevice::GetNas (void) const

{

  NS_LOG_FUNCTION (this);

  return m_nas;

}

uint64_t

LteUeNetDevice::GetImsi () const

{

  NS_LOG_FUNCTION (this);

  return m_imsi;

}

uint16_t

LteUeNetDevice::GetDlEarfcn () const

{

  NS_LOG_FUNCTION (this);

  return m_dlEarfcn;

}

void

LteUeNetDevice::SetDlEarfcn (uint16_t earfcn)

{

  NS_LOG_FUNCTION (this << earfcn);

  m_dlEarfcn = earfcn;

}

uint32_t

LteUeNetDevice::GetCsgId () const

{

  NS_LOG_FUNCTION (this);

  return m_csgId;

}

void

LteUeNetDevice::SetCsgId (uint32_t csgId)

{

  NS_LOG_FUNCTION (this << csgId);

  m_csgId = csgId;

  UpdateConfig (); // propagate the change down to NAS and RRC

}

void

LteUeNetDevice::SetTargetEnb (Ptr<LteEnbNetDevice> enb)

{

  NS_LOG_FUNCTION (this << enb);

  m_targetEnb = enb;

}

Ptr<LteEnbNetDevice>

LteUeNetDevice::GetTargetEnb (void)

{

  NS_LOG_FUNCTION (this);

  return m_targetEnb;

}

void 

LteUeNetDevice::DoInitialize (void)

{

  NS_LOG_FUNCTION (this);

  m_isConstructed = true;

  UpdateConfig ();

  m_phy->Initialize ();

  m_mac->Initialize ();

  m_rrc->Initialize ();

}

bool

LteUeNetDevice::Send (Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber)

{

  NS_LOG_FUNCTION (this << dest << protocolNumber);

  if (protocolNumber != Ipv4L3Protocol::PROT_NUMBER)

    {

      NS_LOG_INFO("unsupported protocol " << protocolNumber << ", only IPv4 is supported");

      return true;

    }  

  return m_nas->Send (packet);

}

} // namespace ns3