wifi-phy.h

Go to the documentation of this file.

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

#ifndef WIFI_PHY_H
#define WIFI_PHY_H

#include <stdint.h>
#include "ns3/callback.h"
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
#include "wifi-mode.h"
#include "wifi-preamble.h"
#include "wifi-phy-standard.h"
#include "ns3/traced-callback.h"
#include "wifi-tx-vector.h"

namespace ns3 {

class WifiChannel;
class NetDevice;

class WifiPhyListener
{
public:
  virtual ~WifiPhyListener ();

  virtual void NotifyRxStart (Time duration) = 0;
  virtual void NotifyRxEndOk (void) = 0;
  virtual void NotifyRxEndError (void) = 0;
  virtual void NotifyTxStart (Time duration, double txPowerDbm) = 0;

  virtual void NotifyMaybeCcaBusyStart (Time duration) = 0;
  virtual void NotifySwitchingStart (Time duration) = 0;
  virtual void NotifySleep (void) = 0;
  virtual void NotifyWakeup (void) = 0;
};


class WifiPhy : public Object
{
public:
  enum State
  {
    IDLE,
    CCA_BUSY,
    TX,
    RX,
    SWITCHING,
    SLEEP
  };

  typedef Callback<void,Ptr<Packet>, double, WifiTxVector, enum WifiPreamble> RxOkCallback;
  typedef Callback<void,Ptr<const Packet>, double> RxErrorCallback;

  static TypeId GetTypeId (void);

  WifiPhy ();
  virtual ~WifiPhy ();

  virtual double GetTxPowerStart (void) const = 0;
  virtual double GetTxPowerEnd (void) const = 0;
  virtual uint32_t GetNTxPower (void) const = 0;

  virtual void SetReceiveOkCallback (RxOkCallback callback) = 0;
  virtual void SetReceiveErrorCallback (RxErrorCallback callback) = 0;

  virtual void SendPacket (Ptr<const Packet> packet, WifiTxVector txvector, enum WifiPreamble preamble, uint8_t packetType) = 0;

  virtual void RegisterListener (WifiPhyListener *listener) = 0;
  virtual void UnregisterListener (WifiPhyListener *listener) = 0;

  virtual void SetSleepMode (void) = 0;
  virtual void ResumeFromSleep (void) = 0;

  virtual bool IsStateIdle (void) = 0;
  virtual bool IsStateCcaBusy (void) = 0;
  virtual bool IsStateBusy (void) = 0;
  virtual bool IsStateRx (void) = 0;
  virtual bool IsStateTx (void) = 0;
  virtual bool IsStateSwitching (void) = 0;
  virtual bool IsStateSleep (void) = 0;
  virtual Time GetStateDuration (void) = 0;
  virtual Time GetDelayUntilIdle (void) = 0;

  virtual Time GetLastRxStartTime (void) const = 0;

  Time CalculateTxDuration (uint32_t size, WifiTxVector txvector, enum WifiPreamble preamble, double frequency, uint8_t packetType, uint8_t incFlag);
  
  Time CalculatePlcpDuration (WifiTxVector txvector, enum WifiPreamble preamble);

  static Time GetPlcpHtTrainingSymbolDuration (WifiPreamble preamble, WifiTxVector txvector);
  static WifiMode GetMFPlcpHeaderMode (WifiMode payloadMode, WifiPreamble preamble);
  static Time GetPlcpHtSigHeaderDuration (WifiPreamble preamble);


  static WifiMode GetPlcpHeaderMode (WifiMode payloadMode, WifiPreamble preamble);

  static Time GetPlcpHeaderDuration (WifiMode payloadMode, WifiPreamble preamble);

  static Time GetPlcpPreambleDuration (WifiMode payloadMode, WifiPreamble preamble);

  Time GetPayloadDuration (uint32_t size, WifiTxVector txvector, WifiPreamble preamble, double frequency, uint8_t packetType, uint8_t incFlag);

  virtual uint32_t GetNModes (void) const = 0;
  virtual WifiMode GetMode (uint32_t mode) const = 0;
  virtual bool IsModeSupported (WifiMode mode) const = 0;
  virtual double CalculateSnr (WifiMode txMode, double ber) const = 0;
  virtual uint32_t GetNBssMembershipSelectors (void) const=0;

  virtual uint32_t GetBssMembershipSelector (uint32_t selector) const=0;
  virtual WifiModeList GetMembershipSelectorModes(uint32_t selector)=0;
  virtual uint8_t GetNMcs (void) const=0;
  virtual uint8_t GetMcs (uint8_t mcs) const=0;

  virtual uint32_t WifiModeToMcs (WifiMode mode)=0;
  virtual WifiMode McsToWifiMode (uint8_t mcs)=0;

  
  virtual void SetChannelNumber (uint16_t id) = 0;
  virtual uint16_t GetChannelNumber (void) const = 0;
  virtual Time GetChannelSwitchDelay (void) const = 0;

  virtual void ConfigureStandard (enum WifiPhyStandard standard) = 0;

  virtual Ptr<WifiChannel> GetChannel (void) const = 0;

  static WifiMode GetDsssRate1Mbps ();
  static WifiMode GetDsssRate2Mbps ();
  static WifiMode GetDsssRate5_5Mbps ();
  static WifiMode GetDsssRate11Mbps ();
  static WifiMode GetErpOfdmRate6Mbps ();
  static WifiMode GetErpOfdmRate9Mbps ();
  static WifiMode GetErpOfdmRate12Mbps ();
  static WifiMode GetErpOfdmRate18Mbps ();
  static WifiMode GetErpOfdmRate24Mbps ();
  static WifiMode GetErpOfdmRate36Mbps ();
  static WifiMode GetErpOfdmRate48Mbps ();
  static WifiMode GetErpOfdmRate54Mbps ();
  static WifiMode GetOfdmRate6Mbps ();
  static WifiMode GetOfdmRate9Mbps ();
  static WifiMode GetOfdmRate12Mbps ();
  static WifiMode GetOfdmRate18Mbps ();
  static WifiMode GetOfdmRate24Mbps ();
  static WifiMode GetOfdmRate36Mbps ();
  static WifiMode GetOfdmRate48Mbps ();
  static WifiMode GetOfdmRate54Mbps ();
  static WifiMode GetOfdmRate3MbpsBW10MHz ();
  static WifiMode GetOfdmRate4_5MbpsBW10MHz ();
  static WifiMode GetOfdmRate6MbpsBW10MHz ();
  static WifiMode GetOfdmRate9MbpsBW10MHz ();
  static WifiMode GetOfdmRate12MbpsBW10MHz ();
  static WifiMode GetOfdmRate18MbpsBW10MHz ();
  static WifiMode GetOfdmRate24MbpsBW10MHz ();
  static WifiMode GetOfdmRate27MbpsBW10MHz ();
  static WifiMode GetOfdmRate1_5MbpsBW5MHz ();
  static WifiMode GetOfdmRate2_25MbpsBW5MHz ();
  static WifiMode GetOfdmRate3MbpsBW5MHz ();
  static WifiMode GetOfdmRate4_5MbpsBW5MHz ();
  static WifiMode GetOfdmRate6MbpsBW5MHz ();
  static WifiMode GetOfdmRate9MbpsBW5MHz ();
  static WifiMode GetOfdmRate12MbpsBW5MHz ();
  static WifiMode GetOfdmRate13_5MbpsBW5MHz ();
  static WifiMode GetOfdmRate6_5MbpsBW20MHz ();
  static WifiMode GetOfdmRate13MbpsBW20MHz ();
  static WifiMode GetOfdmRate19_5MbpsBW20MHz ();
  static WifiMode GetOfdmRate26MbpsBW20MHz ();
  static WifiMode GetOfdmRate39MbpsBW20MHz ();
  static WifiMode GetOfdmRate52MbpsBW20MHz ();
  static WifiMode GetOfdmRate58_5MbpsBW20MHz ();
  static WifiMode GetOfdmRate65MbpsBW20MHz ();
  static WifiMode GetOfdmRate13_5MbpsBW40MHz ();
  static WifiMode GetOfdmRate27MbpsBW40MHz ();
  static WifiMode GetOfdmRate40_5MbpsBW40MHz ();
  static WifiMode GetOfdmRate54MbpsBW40MHz ();
  static WifiMode GetOfdmRate81MbpsBW40MHz ();
  static WifiMode GetOfdmRate108MbpsBW40MHz ();
  static WifiMode GetOfdmRate121_5MbpsBW40MHz ();
  static WifiMode GetOfdmRate135MbpsBW40MHz ();
  //Rates for clause 20 with short guard interval
  static WifiMode GetOfdmRate7_2MbpsBW20MHz ();
  static WifiMode GetOfdmRate14_4MbpsBW20MHz ();
  static WifiMode GetOfdmRate21_7MbpsBW20MHz ();
  static WifiMode GetOfdmRate28_9MbpsBW20MHz ();
  static WifiMode GetOfdmRate43_3MbpsBW20MHz ();
  static WifiMode GetOfdmRate57_8MbpsBW20MHz ();
  static WifiMode GetOfdmRate65MbpsBW20MHzShGi ();
  static WifiMode GetOfdmRate72_2MbpsBW20MHz ();
  static WifiMode GetOfdmRate15MbpsBW40MHz ();
  static WifiMode GetOfdmRate30MbpsBW40MHz (); 
  static WifiMode GetOfdmRate45MbpsBW40MHz ();
  static WifiMode GetOfdmRate60MbpsBW40MHz ();
  static WifiMode GetOfdmRate90MbpsBW40MHz ();
  static WifiMode GetOfdmRate120MbpsBW40MHz ();
  static WifiMode GetOfdmRate135MbpsBW40MHzShGi ();
  static WifiMode GetOfdmRate150MbpsBW40MHz ();


  void NotifyTxBegin (Ptr<const Packet> packet);

  void NotifyTxEnd (Ptr<const Packet> packet);

  void NotifyTxDrop (Ptr<const Packet> packet);

  void NotifyRxBegin (Ptr<const Packet> packet);

  void NotifyRxEnd (Ptr<const Packet> packet);

  void NotifyRxDrop (Ptr<const Packet> packet);

  void NotifyMonitorSniffRx (Ptr<const Packet> packet, uint16_t channelFreqMhz,
                             uint16_t channelNumber, uint32_t rate,
                             bool isShortPreamble, double signalDbm,
                             double noiseDbm);

  typedef void (* MonitorSnifferRxCallback)
    (Ptr<const Packet> packet, uint16_t channelFreqMhz,
     uint16_t channelNumber, uint32_t rate,
     bool isShortPreamble, double signalDbm,
     double noiseDbm);

  void NotifyMonitorSniffTx (Ptr<const Packet> packet, uint16_t channelFreqMhz,
                             uint16_t channelNumber, uint32_t rate,
                             bool isShortPreamble, uint8_t txPower);

  typedef void (* MonitorSnifferTxCallback)
    (const Ptr<const Packet> packet, uint16_t channelFreqMhz,
     uint16_t channelNumber, uint32_t rate,
     bool isShortPreamble, uint8_t txPower);


  virtual int64_t AssignStreams (int64_t stream) = 0;

  virtual void SetFrequency (uint32_t freq)=0;
  virtual uint32_t GetFrequency (void) const=0;
  virtual void SetNumberOfTransmitAntennas (uint32_t tx)=0;

  virtual uint32_t GetNumberOfTransmitAntennas (void) const=0;
  virtual void SetNumberOfReceiveAntennas (uint32_t rx)=0 ;
  virtual uint32_t GetNumberOfReceiveAntennas (void) const=0;
   virtual void SetGuardInterval (bool guardInterval)=0;
  virtual bool GetGuardInterval (void) const = 0;
  virtual void SetLdpc (bool ldpc)=0;
  virtual bool GetLdpc (void) const=0;
  virtual void SetStbc (bool stbc)=0;
  virtual bool GetStbc (void) const=0;
   
  virtual void SetGreenfield (bool greenfield)=0;
  virtual bool GetGreenfield (void) const=0;
  virtual bool GetChannelBonding (void) const = 0;
  virtual void SetChannelBonding (bool channelbonding) = 0 ;

private:
  TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;

  TracedCallback<Ptr<const Packet>, uint16_t, uint16_t, uint32_t, bool, double, double> m_phyMonitorSniffRxTrace;

  TracedCallback<Ptr<const Packet>, uint16_t, uint16_t, uint32_t, bool,uint8_t> m_phyMonitorSniffTxTrace;
    
  uint32_t m_totalAmpduNumSymbols; 
  uint32_t m_totalAmpduSize;       
};

std::ostream& operator<< (std::ostream& os, enum WifiPhy::State state);

} // namespace ns3

#endif /* WIFI_PHY_H */