yans-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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Ghada Badawy <gbadawy@gmail.com>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef YANS_WIFI_PHY_H
#define YANS_WIFI_PHY_H

#include <stdint.h>
#include "ns3/callback.h"
#include "ns3/event-id.h"
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
#include "ns3/random-variable-stream.h"
#include "ns3/mobility-model.h"
#include "wifi-phy.h"
#include "wifi-mode.h"
#include "wifi-preamble.h"
#include "wifi-phy-standard.h"
#include "interference-helper.h"

namespace ns3 {

#define VHT_PHY 126
#define HT_PHY 127

class YansWifiChannel;
class WifiPhyStateHelper;


class YansWifiPhy : public WifiPhy
{
public:
  static TypeId GetTypeId (void);

  YansWifiPhy ();
  virtual ~YansWifiPhy ();

  void SetChannel (Ptr<YansWifiChannel> channel);
  void SetChannelNumber (uint16_t id);
  uint16_t GetChannelNumber (void) const;
  Time GetChannelSwitchDelay (void) const;
  double GetChannelFrequencyMhz () const;

  void StartReceivePreambleAndHeader (Ptr<Packet> packet,
                                      double rxPowerDbm,
                                      WifiTxVector txVector,
                                      WifiPreamble preamble,
                                      enum mpduType mpdutype,
                                      Time rxDuration);
  void StartReceivePacket (Ptr<Packet> packet,
                           WifiTxVector txVector,
                           WifiPreamble preamble,
                           enum mpduType mpdutype,
                           Ptr<InterferenceHelper::Event> event);

  void SetRxNoiseFigure (double noiseFigureDb);
  void SetTxPowerStart (double start);
  void SetTxPowerEnd (double end);
  void SetNTxPower (uint32_t n);
  void SetTxGain (double gain);
  void SetRxGain (double gain);
  void SetEdThreshold (double threshold);
  void SetCcaMode1Threshold (double threshold);
  void SetErrorRateModel (Ptr<ErrorRateModel> rate);
  void SetDevice (Ptr<NetDevice> device);
  void SetMobility (Ptr<MobilityModel> mobility);
  double GetRxNoiseFigure (void) const;
  double GetTxGain (void) const;
  double GetRxGain (void) const;
  double GetEdThreshold (void) const;
  double GetCcaMode1Threshold (void) const;
  Ptr<ErrorRateModel> GetErrorRateModel (void) const;
  Ptr<NetDevice> GetDevice (void) const;
  Ptr<MobilityModel> GetMobility (void);
  virtual double GetTxPowerStart (void) const;
  virtual double GetTxPowerEnd (void) const;
  virtual uint32_t GetNTxPower (void) const;

  virtual void SetReceiveOkCallback (WifiPhy::RxOkCallback callback);
  virtual void SetReceiveErrorCallback (WifiPhy::RxErrorCallback callback);
  virtual void SendPacket (Ptr<const Packet> packet, WifiTxVector txVector, enum WifiPreamble preamble);
  virtual void SendPacket (Ptr<const Packet> packet, WifiTxVector txVector, enum WifiPreamble preamble, enum mpduType mpdutype);
  virtual void RegisterListener (WifiPhyListener *listener);
  virtual void UnregisterListener (WifiPhyListener *listener);
  virtual void SetSleepMode (void);
  virtual void ResumeFromSleep (void);
  virtual bool IsStateCcaBusy (void);
  virtual bool IsStateIdle (void);
  virtual bool IsStateBusy (void);
  virtual bool IsStateRx (void);
  virtual bool IsStateTx (void);
  virtual bool IsStateSwitching (void);
  virtual bool IsStateSleep (void);
  virtual Time GetStateDuration (void);
  virtual Time GetDelayUntilIdle (void);
  virtual Time GetLastRxStartTime (void) const;
  virtual uint32_t GetNModes (void) const;
  virtual WifiMode GetMode (uint32_t mode) const;
  virtual bool IsModeSupported (WifiMode mode) const;
  virtual bool IsMcsSupported (WifiMode mcs);
  virtual double CalculateSnr (WifiTxVector txVector, double ber) const;
  virtual Ptr<WifiChannel> GetChannel (void) const;

  virtual void ConfigureStandard (enum WifiPhyStandard standard);

  int64_t AssignStreams (int64_t stream);

  virtual void SetFrequency (uint32_t freq);
  virtual uint32_t GetFrequency (void) const;
  virtual void SetNumberOfTransmitAntennas (uint32_t tx);
  virtual uint32_t GetNumberOfTransmitAntennas (void) const;
  virtual void SetNumberOfReceiveAntennas (uint32_t rx);
  virtual uint32_t GetNumberOfReceiveAntennas (void) const;
  virtual void SetGuardInterval (bool guardInterval);
  virtual bool GetGuardInterval (void) const;
  virtual void SetLdpc (bool ldpc);
  virtual bool GetLdpc (void) const;
  virtual void SetStbc (bool stbc);
  virtual bool GetStbc (void) const;
  virtual void SetGreenfield (bool greenfield);
  virtual bool GetGreenfield (void) const;
  virtual void SetShortPlcpPreambleSupported (bool preamble);
  virtual bool GetShortPlcpPreambleSupported (void) const;
  virtual uint32_t GetChannelWidth (void) const;
  virtual void SetChannelWidth (uint32_t channelwidth);

  virtual uint8_t GetSupportedRxSpatialStreams (void) const;
  virtual uint8_t GetSupportedTxSpatialStreams (void) const;
  virtual void AddSupportedChannelWidth (uint32_t width);
  virtual std::vector<uint32_t> GetSupportedChannelWidthSet (void) const;
  virtual uint32_t GetNBssMembershipSelectors (void) const;
  virtual uint32_t GetBssMembershipSelector (uint32_t selector) const;
  virtual WifiModeList GetMembershipSelectorModes (uint32_t selector);

  virtual uint8_t GetNMcs (void) const;
  virtual WifiMode GetMcs (uint8_t mcs) const;

private:
  virtual void DoInitialize (void);
  virtual void DoDispose (void);

  void Configure80211a (void);
  void Configure80211b (void);
  void Configure80211g (void);
  void Configure80211_10Mhz (void);
  void Configure80211_5Mhz ();
  void ConfigureHolland (void);
  void Configure80211n (void);
  void Configure80211ac (void);
  void ConfigureHtDeviceMcsSet (void);
  double GetEdThresholdW (void) const;
  double DbmToW (double dbm) const;
  double DbToRatio (double db) const;
  double WToDbm (double w) const;
  double RatioToDb (double ratio) const;
  double GetPowerDbm (uint8_t power) const;
  void EndReceive (Ptr<Packet> packet, enum WifiPreamble preamble, enum mpduType mpdutype, Ptr<InterferenceHelper::Event> event);

  bool     m_initialized;         
  double   m_edThresholdW;        
  double   m_ccaMode1ThresholdW;  
  double   m_txGainDb;            
  double   m_rxGainDb;            
  double   m_txPowerBaseDbm;      
  double   m_txPowerEndDbm;       
  uint32_t m_nTxPower;            

  Ptr<YansWifiChannel> m_channel;        
  uint16_t             m_channelNumber;  
  Ptr<NetDevice>       m_device;         
  Ptr<MobilityModel>   m_mobility;       

  uint32_t m_numberOfTransmitters;  
  uint32_t m_numberOfReceivers;     
  bool     m_ldpc;                  
  bool     m_stbc;                  
  bool     m_greenfield;            
  bool     m_guardInterval;         
  uint32_t m_channelWidth;          
  std::vector<uint32_t> m_supportedChannelWidthSet; 
  bool     m_shortPreamble;         

  WifiModeList m_deviceRateSet;
  WifiModeList m_deviceMcsSet;

  std::vector<uint32_t> m_bssMembershipSelectorSet;
  EventId m_endRxEvent;
  EventId m_endPlcpRxEvent;

  Ptr<UniformRandomVariable> m_random;  
  double m_channelStartingFrequency;    
  Ptr<WifiPhyStateHelper> m_state;      
  InterferenceHelper m_interference;    
  Time m_channelSwitchDelay;            
  uint16_t m_mpdusNum;                  
  bool m_plcpSuccess;                   
  uint32_t m_txMpduReferenceNumber;     
  uint32_t m_rxMpduReferenceNumber;     
};

} //namespace ns3

#endif /* YANS_WIFI_PHY_H */