/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2005,2006 INRIA

 *

 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#include "yans-wifi-phy.h"

#include "yans-wifi-channel.h"

#include "wifi-mode.h"

#include "wifi-preamble.h"

#include "wifi-phy-state-helper.h"

#include "error-rate-model.h"

#include "ns3/simulator.h"

#include "ns3/packet.h"

#include "ns3/assert.h"

#include "ns3/log.h"

#include "ns3/double.h"

#include "ns3/uinteger.h"

#include "ns3/enum.h"

#include "ns3/pointer.h"

#include "ns3/net-device.h"

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

#include <cmath>

NS_LOG_COMPONENT_DEFINE ("YansWifiPhy");

namespace ns3 {

NS_OBJECT_ENSURE_REGISTERED (YansWifiPhy);

TypeId

YansWifiPhy::GetTypeId (void)

{

  static TypeId tid = TypeId ("ns3::YansWifiPhy")

    .SetParent<WifiPhy> ()

    .AddConstructor<YansWifiPhy> ()

    .AddAttribute ("EnergyDetectionThreshold",

                   "The energy of a received signal should be higher than "

                   "this threshold (dbm) to allow the PHY layer to detect the signal.",

                   DoubleValue (-96.0),

                   MakeDoubleAccessor (&YansWifiPhy::SetEdThreshold,

                                       &YansWifiPhy::GetEdThreshold),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("CcaMode1Threshold",

                   "The energy of a received signal should be higher than "

                   "this threshold (dbm) to allow the PHY layer to declare CCA BUSY state",

                   DoubleValue (-99.0),

                   MakeDoubleAccessor (&YansWifiPhy::SetCcaMode1Threshold,

                                       &YansWifiPhy::GetCcaMode1Threshold),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("TxGain",

                   "Transmission gain (dB).",

                   DoubleValue (1.0),

                   MakeDoubleAccessor (&YansWifiPhy::SetTxGain,

                                       &YansWifiPhy::GetTxGain),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("RxGain",

                   "Reception gain (dB).",

                   DoubleValue (1.0),

                   MakeDoubleAccessor (&YansWifiPhy::SetRxGain,

                                       &YansWifiPhy::GetRxGain),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("TxPowerLevels",

                   "Number of transmission power levels available between "

                   "TxPowerStart and TxPowerEnd included.",

                   UintegerValue (1),

                   MakeUintegerAccessor (&YansWifiPhy::m_nTxPower),

                   MakeUintegerChecker<uint32_t> ())

    .AddAttribute ("TxPowerEnd",

                   "Maximum available transmission level (dbm).",

                   DoubleValue (16.0206),

                   MakeDoubleAccessor (&YansWifiPhy::SetTxPowerEnd,

                                       &YansWifiPhy::GetTxPowerEnd),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("TxPowerStart",

                   "Minimum available transmission level (dbm).",

                   DoubleValue (16.0206),

                   MakeDoubleAccessor (&YansWifiPhy::SetTxPowerStart,

                                       &YansWifiPhy::GetTxPowerStart),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("RxNoiseFigure",

                   "Loss (dB) in the Signal-to-Noise-Ratio due to non-idealities in the receiver."

                   " According to Wikipedia (http://en.wikipedia.org/wiki/Noise_figure), this is "

                   "\"the difference in decibels (dB) between"

                   " the noise output of the actual receiver to the noise output of an "

                   " ideal receiver with the same overall gain and bandwidth when the receivers "

                   " are connected to sources at the standard noise temperature T0 (usually 290 K)\"."

                   " For",

                   DoubleValue (7),

                   MakeDoubleAccessor (&YansWifiPhy::SetRxNoiseFigure,

                                       &YansWifiPhy::GetRxNoiseFigure),

                   MakeDoubleChecker<double> ())

    .AddAttribute ("State", "The state of the PHY layer",

                   PointerValue (),

                   MakePointerAccessor (&YansWifiPhy::m_state),

                   MakePointerChecker<WifiPhyStateHelper> ())

    .AddAttribute ("ChannelSwitchDelay",

                   TimeValue (MicroSeconds (250)),

                   MakeTimeAccessor (&YansWifiPhy::m_channelSwitchDelay),

                   MakeTimeChecker ())

    .AddAttribute ("ChannelNumber",

                   UintegerValue (1),

                   MakeUintegerAccessor (&YansWifiPhy::SetChannelNumber,

                                         &YansWifiPhy::GetChannelNumber),

                   MakeUintegerChecker<uint16_t> ())

  ;

  return tid;

}

YansWifiPhy::YansWifiPhy ()

  :  m_channelNumber (1),

    m_endRxEvent (),

    m_channelStartingFrequency (0)

{

  NS_LOG_FUNCTION (this);

  m_random = CreateObject<UniformRandomVariable> ();

  m_state = CreateObject<WifiPhyStateHelper> ();

}

YansWifiPhy::~YansWifiPhy ()

{

  NS_LOG_FUNCTION (this);

}

void

YansWifiPhy::DoDispose (void)

{

  NS_LOG_FUNCTION (this);

  m_channel = 0;

  m_deviceRateSet.clear ();

  m_device = 0;

  m_mobility = 0;

  m_state = 0;

}

void

YansWifiPhy::ConfigureStandard (enum WifiPhyStandard standard)

{

  NS_LOG_FUNCTION (this << standard);

  switch (standard)

    {

    case WIFI_PHY_STANDARD_80211a:

      Configure80211a ();

      break;

    case WIFI_PHY_STANDARD_80211b:

      Configure80211b ();

      break;

    case WIFI_PHY_STANDARD_80211g:

      Configure80211g ();

      break;

    case WIFI_PHY_STANDARD_80211_10MHZ:

      Configure80211_10Mhz ();

      break;

    case WIFI_PHY_STANDARD_80211_5MHZ:

      Configure80211_5Mhz ();

      break;

    case WIFI_PHY_STANDARD_holland:

      ConfigureHolland ();

      break;

    case WIFI_PHY_STANDARD_80211p_CCH:

      Configure80211p_CCH ();

      break;

    case WIFI_PHY_STANDARD_80211p_SCH:

      Configure80211p_SCH ();

      break;

    default:

      NS_ASSERT (false);

      break;

    }

}

void

YansWifiPhy::SetRxNoiseFigure (double noiseFigureDb)

{

  NS_LOG_FUNCTION (this << noiseFigureDb);

  m_interference.SetNoiseFigure (DbToRatio (noiseFigureDb));

}

void

YansWifiPhy::SetTxPowerStart (double start)

{

  NS_LOG_FUNCTION (this << start);

  m_txPowerBaseDbm = start;

}

void

YansWifiPhy::SetTxPowerEnd (double end)

{

  NS_LOG_FUNCTION (this << end);

  m_txPowerEndDbm = end;

}

void

YansWifiPhy::SetNTxPower (uint32_t n)

{

  NS_LOG_FUNCTION (this << n);

  m_nTxPower = n;

}

void

YansWifiPhy::SetTxGain (double gain)

{

  NS_LOG_FUNCTION (this << gain);

  m_txGainDb = gain;

}

void

YansWifiPhy::SetRxGain (double gain)

{

  NS_LOG_FUNCTION (this << gain);

  m_rxGainDb = gain;

}

void

YansWifiPhy::SetEdThreshold (double threshold)

{

  NS_LOG_FUNCTION (this << threshold);

  m_edThresholdW = DbmToW (threshold);

}

void

YansWifiPhy::SetCcaMode1Threshold (double threshold)

{

  NS_LOG_FUNCTION (this << threshold);

  m_ccaMode1ThresholdW = DbmToW (threshold);

}

void

YansWifiPhy::SetErrorRateModel (Ptr<ErrorRateModel> rate)

{

  m_interference.SetErrorRateModel (rate);

}

void

YansWifiPhy::SetDevice (Ptr<Object> device)

{

  m_device = device;

}

void

YansWifiPhy::SetMobility (Ptr<Object> mobility)

{

  m_mobility = mobility;

}

double

YansWifiPhy::GetRxNoiseFigure (void) const

{

  return RatioToDb (m_interference.GetNoiseFigure ());

}

double

YansWifiPhy::GetTxPowerStart (void) const

{

  return m_txPowerBaseDbm;

}

double

YansWifiPhy::GetTxPowerEnd (void) const

{

  return m_txPowerEndDbm;

}

double

YansWifiPhy::GetTxGain (void) const

{

  return m_txGainDb;

}

double

YansWifiPhy::GetRxGain (void) const

{

  return m_rxGainDb;

}

double

YansWifiPhy::GetEdThreshold (void) const

{

  return WToDbm (m_edThresholdW);

}

double

YansWifiPhy::GetCcaMode1Threshold (void) const

{

  return WToDbm (m_ccaMode1ThresholdW);

}

Ptr<ErrorRateModel>

YansWifiPhy::GetErrorRateModel (void) const

{

  return m_interference.GetErrorRateModel ();

}

Ptr<Object>

YansWifiPhy::GetDevice (void) const

{

  return m_device;

}

Ptr<Object>

YansWifiPhy::GetMobility (void)

{

  return m_mobility;

}

double

YansWifiPhy::CalculateSnr (WifiMode txMode, double ber) const

{

  return m_interference.GetErrorRateModel ()->CalculateSnr (txMode, ber);

}

Ptr<WifiChannel>

YansWifiPhy::GetChannel (void) const

{

  return m_channel;

}

void

YansWifiPhy::SetChannel (Ptr<YansWifiChannel> channel)

{

  m_channel = channel;

  m_channel->Add (this);

}

void

YansWifiPhy::SetChannelNumber (uint16_t nch)

{

  if (Simulator::Now () == Seconds (0))

    {

      // this is not channel switch, this is initialization

      NS_LOG_DEBUG ("start at channel " << nch);

      m_channelNumber = nch;

      return;

    }

  NS_ASSERT (!IsStateSwitching ());

  switch (m_state->GetState ())

    {

    case YansWifiPhy::RX:

      NS_LOG_DEBUG ("drop packet because of channel switching while reception");

      m_endRxEvent.Cancel ();

      goto switchChannel;

      break;

    case YansWifiPhy::TX:

      NS_LOG_DEBUG ("channel switching postponed until end of current transmission");

      Simulator::Schedule (GetDelayUntilIdle (), &YansWifiPhy::SetChannelNumber, this, nch);

      break;

    case YansWifiPhy::CCA_BUSY:

    case YansWifiPhy::IDLE:

      goto switchChannel;

      break;

    default:

      NS_ASSERT (false);

      break;

    }

  return;

switchChannel:

  NS_LOG_DEBUG ("switching channel " << m_channelNumber << " -> " << nch);

  m_state->SwitchToChannelSwitching (m_channelSwitchDelay);

  m_interference.EraseEvents ();

  /*

   * Needed here to be able to correctly sensed the medium for the first

   * time after the switching. The actual switching is not performed until

   * after m_channelSwitchDelay. Packets received during the switching

   * state are added to the event list and are employed later to figure

   * out the state of the medium after the switching.

   */

  m_channelNumber = nch;

}

uint16_t

YansWifiPhy::GetChannelNumber () const

{

  return m_channelNumber;

}

double

YansWifiPhy::GetChannelFrequencyMhz () const

{

  return m_channelStartingFrequency + 5 * GetChannelNumber ();

}

void

YansWifiPhy::SetReceiveOkCallback (RxOkCallback callback)

{

  m_state->SetReceiveOkCallback (callback);

}

void

YansWifiPhy::SetReceiveErrorCallback (RxErrorCallback callback)

{

  m_state->SetReceiveErrorCallback (callback);

}

void

YansWifiPhy::StartReceivePacket (Ptr<Packet> packet,

                                 double rxPowerDbm,

                                 WifiMode txMode,

                                 enum WifiPreamble preamble)

{

  NS_LOG_FUNCTION (this << packet << rxPowerDbm << txMode << preamble);

  rxPowerDbm += m_rxGainDb;

  double rxPowerW = DbmToW (rxPowerDbm);

  Time rxDuration = CalculateTxDuration (packet->GetSize (), txMode, preamble);

  Time endRx = Simulator::Now () + rxDuration;

  Ptr<InterferenceHelper::Event> event;

  event = m_interference.Add (packet->GetSize (),

                              txMode,

                              preamble,

                              rxDuration,

                              rxPowerW);

  switch (m_state->GetState ())

    {

    case YansWifiPhy::SWITCHING:

      NS_LOG_DEBUG ("drop packet because of channel switching");

      NotifyRxDrop (packet);

      /*

       * Packets received on the upcoming channel are added to the event list

       * during the switching state. This way the medium can be correctly sensed

       * when the device listens to the channel for the first time after the

       * switching e.g. after channel switching, the channel may be sensed as

       * busy due to other devices' tramissions started before the end of

       * the switching.

       */

      if (endRx > Simulator::Now () + m_state->GetDelayUntilIdle ())

        {

          // that packet will be noise _after_ the completion of the

          // channel switching.

          goto maybeCcaBusy;

        }

      break;

    case YansWifiPhy::RX:

      NS_LOG_DEBUG ("drop packet because already in Rx (power=" <<

                    rxPowerW << "W)");

      NotifyRxDrop (packet);

      if (endRx > Simulator::Now () + m_state->GetDelayUntilIdle ())

        {

          // that packet will be noise _after_ the reception of the

          // currently-received packet.

          goto maybeCcaBusy;

        }

      break;

    case YansWifiPhy::TX:

      NS_LOG_DEBUG ("drop packet because already in Tx (power=" <<

                    rxPowerW << "W)");

      NotifyRxDrop (packet);

      if (endRx > Simulator::Now () + m_state->GetDelayUntilIdle ())

        {

          // that packet will be noise _after_ the transmission of the

          // currently-transmitted packet.

          goto maybeCcaBusy;

        }

      break;

    case YansWifiPhy::CCA_BUSY:

    case YansWifiPhy::IDLE:

      if (rxPowerW > m_edThresholdW)

        {

          NS_LOG_DEBUG ("sync to signal (power=" << rxPowerW << "W)");

          // sync to signal

          m_state->SwitchToRx (rxDuration);

          NS_ASSERT (m_endRxEvent.IsExpired ());

          NotifyRxBegin (packet);

          m_interference.NotifyRxStart ();

          m_endRxEvent = Simulator::Schedule (rxDuration, &YansWifiPhy::EndReceive, this,

                                              packet,

                                              event);

        }

      else

        {

          NS_LOG_DEBUG ("drop packet because signal power too Small (" <<

                        rxPowerW << "<" << m_edThresholdW << ")");

          NotifyRxDrop (packet);

          goto maybeCcaBusy;

        }

      break;

    }

  return;