wifi-phy.h

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


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) = 0;

  virtual void NotifyMaybeCcaBusyStart (Time duration) = 0;
  virtual void NotifySwitchingStart (Time duration, uint16_t toChannel) = 0;
  virtual void NotifySensingStart (Time duration) = 0;
};


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

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

  typedef Callback<void> SnsEndedCallback;
  typedef Callback<void> HandoffEndedCallback;

  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 SetSenseEndedCallback(SnsEndedCallback callback) = 0;
  virtual void SetHandoffEndedCallback(HandoffEndedCallback callback) = 0;

  virtual void SendPacket (Ptr<const Packet> packet, WifiMode mode, enum WifiPreamble preamble, uint8_t txPowerLevel) = 0;

  virtual void RegisterListener (WifiPhyListener *listener) = 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 IsStateSensing (void) = 0;
  virtual Time GetStateDuration (void) = 0;
  virtual Time GetDelayUntilIdle (void) = 0;

  virtual Time GetLastRxStartTime (void) const = 0;

  static Time CalculateTxDuration (uint32_t size, WifiMode payloadMode, enum WifiPreamble preamble);

  static WifiMode GetPlcpHeaderMode (WifiMode payloadMode, WifiPreamble preamble);

  static uint32_t GetPlcpHeaderDurationMicroSeconds (WifiMode payloadMode, WifiPreamble preamble);

  static uint32_t GetPlcpPreambleDurationMicroSeconds (WifiMode payloadMode, WifiPreamble preamble);

  static uint32_t GetPayloadDurationMicroSeconds (uint32_t size, WifiMode payloadMode);

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

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

  virtual void StartSensing (Time duration) = 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 ();


  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);

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

  virtual int64_t AssignStreams (int64_t stream) = 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> m_phyMonitorSniffTxTrace;

};

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

} // namespace ns3

#endif /* WIFI_PHY_H */