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

 *

 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 *          Sébastien Deronne <sebastien.deronne@gmail.com>

 */

#ifndef WIFI_PHY_H

#define WIFI_PHY_H

#include "ns3/event-id.h"

#include "wifi-mpdu-type.h"

#include "wifi-phy-standard.h"

#include "interference-helper.h"

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

namespace ns3 {

#define HE_PHY 125

#define VHT_PHY 126

#define HT_PHY 127

class Channel;

class NetDevice;

class MobilityModel;

class WifiPhyStateHelper;

class FrameCaptureModel;

class WifiRadioEnergyModel;

class UniformRandomVariable;

/// SignalNoiseDbm structure

struct SignalNoiseDbm

{

  double signal; ///< in dBm

  double noise; ///< in dBm

};

/// MpduInfo structure

struct MpduInfo

{

  MpduType type; ///< type

  uint32_t mpduRefNumber; ///< MPDU ref number

};

/**

 * \brief 802.11 PHY layer model

 * \ingroup wifi

 *

 */

class WifiPhy : public Object

{

public:

  /**

   * \brief Get the type ID.

   * \return the object TypeId

   */

  static TypeId GetTypeId (void);

  WifiPhy ();

  virtual ~WifiPhy ();

  /**

   * \param callback the callback to invoke

   *        upon successful packet reception.

   */

  void SetReceiveOkCallback (RxOkCallback callback);

  /**

   * \param callback the callback to invoke

   *        upon erroneous packet reception.

   */

  void SetReceiveErrorCallback (RxErrorCallback callback);

  /**

   * \param listener the new listener

   *

   * Add the input listener to the list of objects to be notified of

   * PHY-level events.

   */

  void RegisterListener (WifiPhyListener *listener);

  /**

   * \param listener the listener to be unregistered

   *

   * Remove the input listener from the list of objects to be notified of

   * PHY-level events.

   */

  void UnregisterListener (WifiPhyListener *listener);

  /**

   * \param callback the callback to invoke when PHY capabilities have changed.

   */

  void SetCapabilitiesChangedCallback (Callback<void> callback);

  /**

   * Starting receiving the plcp of a packet (i.e. the first bit of the preamble has arrived).

   *

   * \param packet the arriving packet

   * \param rxPowerW the receive power in W

   * \param rxDuration the duration needed for the reception of the packet

   */

  void StartReceivePreambleAndHeader (Ptr<Packet> packet,

                                      double rxPowerW,

                                      Time rxDuration);

  /**

   * Starting receiving the payload of a packet (i.e. the first bit of the packet has arrived).

   *

   * \param packet the arriving packet

   * \param txVector the TXVECTOR of the arriving packet

   * \param mpdutype the type of the MPDU as defined in WifiPhy::MpduType.

   * \param event the corresponding event of the first time the packet arrives

   */

  void StartReceivePacket (Ptr<Packet> packet,

                           WifiTxVector txVector,

                           MpduType mpdutype,

                           Ptr<Event> event);

  /**

   * The last bit of the packet has arrived.

   *

   * \param packet the packet that the last bit has arrived

   * \param preamble the preamble of the arriving packet

   * \param mpdutype the type of the MPDU as defined in WifiPhy::MpduType.

   * \param event the corresponding event of the first time the packet arrives

   */

  void EndReceive (Ptr<Packet> packet, WifiPreamble preamble, MpduType mpdutype, Ptr<Event> event);

  /**

   * \param packet the packet to send

   * \param txVector the TXVECTOR that has tx parameters such as mode, the transmission mode to use to send

   *        this packet, and txPowerLevel, a power level to use to send this packet. The real transmission

   *        power is calculated as txPowerMin + txPowerLevel * (txPowerMax - txPowerMin) / nTxLevels

   * \param mpdutype the type of the MPDU as defined in WifiPhy::MpduType.

   */

  void SendPacket (Ptr<const Packet> packet, WifiTxVector txVector, MpduType mpdutype = NORMAL_MPDU);

  /**

   * \param packet the packet to send

   * \param txVector the TXVECTOR that has tx parameters such as mode, the transmission mode to use to send

   *        this packet, and txPowerLevel, a power level to use to send this packet. The real transmission

   *        power is calculated as txPowerMin + txPowerLevel * (txPowerMax - txPowerMin) / nTxLevels

   * \param txDuration duration of the transmission.

   */

  virtual void StartTx (Ptr<Packet> packet, WifiTxVector txVector, Time txDuration) = 0;

  /**

   * Put in sleep mode.

   */

  void SetSleepMode (void);

  /**

   * Resume from sleep mode.

   */

  void ResumeFromSleep (void);

  /**

   * Put in off mode.

   */

  void SetOffMode (void);

  /**

   * Resume from off mode.

   */

  void ResumeFromOff (void);

  /**

   * \return true of the current state of the PHY layer is WifiPhy::IDLE, false otherwise.

   */

  bool IsStateIdle (void) const;

  /**

   * \return true of the current state of the PHY layer is WifiPhy::CCA_BUSY, false otherwise.

   */

  bool IsStateCcaBusy (void) const;

  /**

   * \return true of the current state of the PHY layer is WifiPhy::RX, false otherwise.

   */

  bool IsStateRx (void) const;

  /**

   * \return true of the current state of the PHY layer is WifiPhy::TX, false otherwise.

   */

  bool IsStateTx (void) const;

  /**

   * \return true of the current state of the PHY layer is WifiPhy::SWITCHING, false otherwise.

   */

  bool IsStateSwitching (void) const;

  /**

   * \return true if the current state of the PHY layer is WifiPhy::SLEEP, false otherwise.

   */

  bool IsStateSleep (void) const;

  /**

   * \return true if the current state of the PHY layer is WifiPhy::OFF, false otherwise.

   */

  bool IsStateOff (void) const;

  /**

   * \return the predicted delay until this PHY can become WifiPhy::IDLE.

   *

   * The PHY will never become WifiPhy::IDLE _before_ the delay returned by

   * this method but it could become really idle later.

   */

  Time GetDelayUntilIdle (void);

  /**

   * Return the start time of the last received packet.

   *

   * \return the start time of the last received packet

   */

  Time GetLastRxStartTime (void) const;

  /**

   * \param size the number of bytes in the packet to send

   * \param txVector the TXVECTOR used for the transmission of this packet

   * \param frequency the channel center frequency (MHz)

   *

   * \return the total amount of time this PHY will stay busy for the transmission of these bytes.

   */

  Time CalculateTxDuration (uint32_t size, WifiTxVector txVector, uint16_t frequency);

  /**

   * \param size the number of bytes in the packet to send

   * \param txVector the TXVECTOR used for the transmission of this packet

   * \param frequency the channel center frequency (MHz)

   * \param mpdutype the type of the MPDU as defined in WifiPhy::MpduType.

   * \param incFlag this flag is used to indicate that the static variables need to be update or not. This function is called a couple of times for the same packet so static variables should not be increased each time.

   *

   * \return the total amount of time this PHY will stay busy for the transmission of these bytes.

   */

  Time CalculateTxDuration (uint32_t size, WifiTxVector txVector, uint16_t frequency, MpduType mpdutype, uint8_t incFlag);

  /**

   * \param txVector the transmission parameters used for this packet

   *

   * \return the total amount of time this PHY will stay busy for the transmission of the PLCP preamble and PLCP header.

   */

  static Time CalculatePlcpPreambleAndHeaderDuration (WifiTxVector txVector);

  /**

   * \param txVector the transmission parameters used for this packet

   *

   * \return the training symbol duration

   */

  static Time GetPlcpTrainingSymbolDuration (WifiTxVector txVector);

  /**

   * \return the WifiMode used for the transmission of the HT-SIG and the HT training fields

   *         in Mixed Format and greenfield format PLCP header

   */

  static WifiMode GetHtPlcpHeaderMode ();

  /**

   * \return the WifiMode used for the transmission of the VHT-STF, VHT-LTF and VHT-SIG-B fields

   */

  static WifiMode GetVhtPlcpHeaderMode ();

  /**

   * \return the WifiMode used for the transmission of the HE-STF, HE-LTF and HE-SIG-B fields

   */

  static WifiMode GetHePlcpHeaderMode ();

  /**

   * \param preamble the type of preamble

   *

   * \return the duration of the HT-SIG in Mixed Format and greenfield format PLCP header

   */

  static Time GetPlcpHtSigHeaderDuration (WifiPreamble preamble);

  /**

   * \param preamble the type of preamble

   *

   * \return the duration of the SIG-A1 in PLCP header

   */

  static Time GetPlcpSigA1Duration (WifiPreamble preamble);

  /**

   * \param preamble the type of preamble

   *

   * \return the duration of the SIG-A2 in PLCP header

   */

  static Time GetPlcpSigA2Duration (WifiPreamble preamble);

  /**

   * \param preamble the type of preamble

   *

   * \return the duration of the SIG-B in PLCP header

   */

  static Time GetPlcpSigBDuration (WifiPreamble preamble);

  /**

   * \param txVector the transmission parameters used for this packet

   *

   * \return the WifiMode used for the transmission of the PLCP header

   */

  static WifiMode GetPlcpHeaderMode (WifiTxVector txVector);

  /**

   * \param txVector the transmission parameters used for this packet

   *

   * \return the duration of the PLCP header

   */

  static Time GetPlcpHeaderDuration (WifiTxVector txVector);

  /**

   * \param txVector the transmission parameters used for this packet

   *

   * \return the duration of the PLCP preamble

   */

  static Time GetPlcpPreambleDuration (WifiTxVector txVector);

  /**

   * \param size the number of bytes in the packet to send

   * \param txVector the TXVECTOR used for the transmission of this packet

   * \param frequency the channel center frequency (MHz)

   *

   * \return the duration of the payload

   */

  Time GetPayloadDuration (uint32_t size, WifiTxVector txVector, uint16_t frequency);

  /**

   * \param size the number of bytes in the packet to send

   * \param txVector the TXVECTOR used for the transmission of this packet

   * \param frequency the channel center frequency (MHz)

   * \param mpdutype the type of the MPDU as defined in WifiPhy::MpduType.

   * \param incFlag this flag is used to indicate that the static variables need to be update or not. This function is called a couple of times for the same packet so static variables should not be increased each time

   *

   * \return the duration of the payload

   */

  Time GetPayloadDuration (uint32_t size, WifiTxVector txVector, uint16_t frequency, MpduType mpdutype, uint8_t incFlag);

  /**

   * The WifiPhy::GetNModes() and WifiPhy::GetMode() methods are used

   * (e.g., by a WifiRemoteStationManager) to determine the set of

   * transmission/reception modes that this WifiPhy(-derived class)

   * can support - a set of WifiMode objects which we call the

   * DeviceRateSet, and which is stored as WifiPhy::m_deviceRateSet.

   *

   * It is important to note that the DeviceRateSet is a superset (not

   * necessarily proper) of the OperationalRateSet (which is

   * logically, if not actually, a property of the associated

   * WifiRemoteStationManager), which itself is a superset (again, not

   * necessarily proper) of the BSSBasicRateSet.

   *

   * \return the number of transmission modes supported by this PHY.

   *

   * \sa WifiPhy::GetMode()

   */

  uint8_t GetNModes (void) const;

  /**

   * The WifiPhy::GetNModes() and WifiPhy::GetMode() methods are used

   * (e.g., by a WifiRemoteStationManager) to determine the set of

   * transmission/reception modes that this WifiPhy(-derived class)

   * can support - a set of WifiMode objects which we call the

   * DeviceRateSet, and which is stored as WifiPhy::m_deviceRateSet.

   *

   * It is important to note that the DeviceRateSet is a superset (not

   * necessarily proper) of the OperationalRateSet (which is

   * logically, if not actually, a property of the associated

   * WifiRemoteStationManager), which itself is a superset (again, not

   * necessarily proper) of the BSSBasicRateSet.

   *

   * \param mode index in array of supported modes

   *

   * \return the mode whose index is specified.

   *

   * \sa WifiPhy::GetNModes()

   */

  WifiMode GetMode (uint8_t mode) const;

  /**

   * Check if the given WifiMode is supported by the PHY.

   *

   * \param mode the wifi mode to check

   *

   * \return true if the given mode is supported,

   *         false otherwise

   */

  bool IsModeSupported (WifiMode mode) const;

  /**

   * Check if the given WifiMode is supported by the PHY.

   *

   * \param mcs the wifi mode to check

   *

   * \return true if the given mode is supported,

   *         false otherwise

   */

  bool IsMcsSupported (WifiMode mcs) const;

  /**

   * \param txVector the transmission vector

   * \param ber the probability of bit error rate

   *

   * \return the minimum snr which is required to achieve

   *          the requested ber for the specified transmission vector. (W/W)

   */

  double CalculateSnr (WifiTxVector txVector, double ber) const;

  /**

  * The WifiPhy::NBssMembershipSelectors() method is used

  * (e.g., by a WifiRemoteStationManager) to determine the set of

  * transmission/reception modes that this WifiPhy(-derived class)

  * can support - a set of WifiMode objects which we call the

  * BssMembershipSelectorSet, and which is stored as WifiPhy::m_bssMembershipSelectorSet.

  *

  * \return the memebership selector whose index is specified.

  */

  uint8_t GetNBssMembershipSelectors (void) const;

  /**

  * The WifiPhy::BssMembershipSelector() method is used

  * (e.g., by a WifiRemoteStationManager) to determine the set of

  * transmission/reception modes that this WifiPhy(-derived class)

  * can support - a set of WifiMode objects which we call the

  * BssMembershipSelectorSet, and which is stored as WifiPhy::m_bssMembershipSelectorSet.

  *

  * \param selector index in array of supported memberships

  *

  * \return the memebership selector whose index is specified.

  */

  uint8_t GetBssMembershipSelector (uint8_t selector) const;

  /**

   * The WifiPhy::GetNMcs() method is used

   * (e.g., by a WifiRemoteStationManager) to determine the set of

   * transmission/reception MCS indexes that this WifiPhy(-derived class)

   * can support - a set of MCS indexes which we call the

   * DeviceMcsSet, and which is stored as WifiPhy::m_deviceMcsSet.

   *

   * \return the MCS index whose index is specified.

   */

  uint8_t GetNMcs (void) const;

  /**

   * The WifiPhy::GetMcs() method is used

   * (e.g., by a WifiRemoteStationManager) to determine the set of

   * transmission/reception MCS indexes that this WifiPhy(-derived class)

   * can support - a set of MCS indexes which we call the

   * DeviceMcsSet, and which is stored as WifiPhy::m_deviceMcsSet.

   *

   * \param mcs index in array of supported MCS

   *

   * \return the MCS index whose index is specified.

   */

  WifiMode GetMcs (uint8_t mcs) const;

  /**

   * \brief Set channel number.

   *

   * Channel center frequency = Channel starting frequency + 5 MHz * (nch - 1)

   *

   * where Starting channel frequency is standard-dependent,

   * as defined in (Section 18.3.8.4.2 "Channel numbering"; IEEE Std 802.11-2012).

   * This method may fail to take action if the Phy model determines that

   * the channel number cannot be switched for some reason (e.g. sleep state)

   *

   * \param id the channel number

   */

  virtual void SetChannelNumber (uint8_t id);

  /**

   * Return current channel number.

   *

   * \return the current channel number

   */

  uint8_t GetChannelNumber (void) const;

  /**

   * \return the required time for channel switch operation of this WifiPhy

   */

  Time GetChannelSwitchDelay (void) const;

  /**

   * Configure the PHY-level parameters for different Wi-Fi standard.

   *

   * \param standard the Wi-Fi standard

   */

  virtual void ConfigureStandard (WifiPhyStandard standard);

  /**

   * Get the configured Wi-Fi standard

   *

   * \return the Wi-Fi standard that has been configured

   */

  WifiPhyStandard GetStandard (void) const;

  /**

   * Add a channel definition to the WifiPhy.  The pair (channelNumber,

   * WifiPhyStandard) may then be used to lookup a pair (frequency,

   * channelWidth).

   *

   * If the channel is not already defined for the standard, the method