wifi-mac.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 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_MAC_H
#define WIFI_MAC_H

#include "ns3/packet.h"
#include "ns3/mac48-address.h"
#include "ns3/node.h"
#include "ns3/repository.h"
#include "ns3/PUmodel.h"

#include "wifi-phy.h"
#include "wifi-remote-station-manager.h"
#include "ssid.h"
#include "qos-utils.h"

namespace ns3 {

class Dcf;

class WifiMac : public Object
{
public:
  static TypeId GetTypeId (void);

  virtual void SetSlot (Time slotTime) = 0;
  virtual void SetSifs (Time sifs) = 0;
  virtual void SetEifsNoDifs (Time eifsNoDifs) = 0;
  virtual void SetPifs (Time pifs) = 0;
  virtual void SetCtsTimeout (Time ctsTimeout) = 0;
  virtual void SetAckTimeout (Time ackTimeout) = 0;
  void SetMaxPropagationDelay (Time delay);

  virtual Time GetPifs (void) const = 0;
  virtual Time GetSifs (void) const = 0;
  virtual Time GetSlot (void) const = 0;
  virtual Time GetEifsNoDifs (void) const = 0;
  virtual Time GetCtsTimeout (void) const = 0;
  virtual Time GetAckTimeout (void) const = 0;
  Time GetMsduLifetime (void) const;
  Time GetMaxPropagationDelay (void) const;

  virtual Mac48Address GetAddress (void) const = 0;
  virtual Ssid GetSsid (void) const = 0;
  virtual void SetAddress (Mac48Address address) = 0;
  virtual void SetSsid (Ssid ssid) = 0;
  virtual Mac48Address GetBssid (void) const = 0;
  virtual void SetPromisc (void) = 0;

  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from) = 0;
  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to) = 0;
  virtual bool SupportsSendFrom (void) const = 0;
  virtual void SetWifiPhy (Ptr<WifiPhy> phy) = 0;
  virtual void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager) = 0;
  virtual void SetForwardUpCallback (Callback<void,Ptr<Packet>, Mac48Address, Mac48Address> upCallback) = 0;
  virtual void SetLinkUpCallback (Callback<void> linkUp) = 0;
  virtual void SetLinkDownCallback (Callback<void> linkDown) = 0;
  /* Next functions are not pure virtual so non Qos WifiMacs are not
   * forced to implement them.
   */
  virtual void SetBasicBlockAckTimeout (Time blockAckTimeout);
  virtual Time GetBasicBlockAckTimeout (void) const;
  virtual void SetCompressedBlockAckTimeout (Time blockAckTimeout);
  virtual Time GetCompressedBlockAckTimeout (void) const;
  virtual bool IsTxRadio (void) = 0;
  virtual void SetTxRadio (bool isTx) = 0;
  virtual bool IsRxRadio (void) = 0;
  virtual void SetRxRadio (bool isRx, Ptr<Node> node, Ptr<Repository> repo,
      Ptr<PUModel> puModel, Ptr<WifiPhy> phy) = 0;

  void NotifyTx (Ptr<const Packet> packet);

  void NotifyTxDrop (Ptr<const Packet> packet);

  void NotifyRx (Ptr<const Packet> packet);

  void NotifyPromiscRx (Ptr<const Packet> packet);

  void NotifyRxDrop (Ptr<const Packet> packet);
  void ConfigureStandard (enum WifiPhyStandard standard);

protected:
  void ConfigureDcf (Ptr<Dcf> dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac);
  void ConfigureCCHDcf (Ptr<Dcf> dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac);
private:
  static Time GetDefaultMaxPropagationDelay (void);
  static Time GetDefaultSlot (void);
  static Time GetDefaultSifs (void);
  static Time GetDefaultEifsNoDifs (void);
  static Time GetDefaultCtsAckDelay (void);
  static Time GetDefaultCtsAckTimeout (void);
  static Time GetDefaultBasicBlockAckDelay (void);
  static Time GetDefaultBasicBlockAckTimeout (void);
  static Time GetDefaultCompressedBlockAckDelay (void);
  static Time GetDefaultCompressedBlockAckTimeout (void);
  virtual void FinishConfigureStandard (enum WifiPhyStandard standard) = 0;

  Time m_maxPropagationDelay;

  void Configure80211a (void);
  void Configure80211b (void);
  void Configure80211g (void);
  void Configure80211_10Mhz (void);
  void Configure80211_5Mhz ();
  void Configure80211p_CCH (void);
  void Configure80211p_SCH (void);

  TracedCallback<Ptr<const Packet> > m_macTxTrace;

  TracedCallback<Ptr<const Packet> > m_macTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_macPromiscRxTrace;

  TracedCallback<Ptr<const Packet> > m_macRxTrace;

  TracedCallback<Ptr<const Packet> > m_macRxDropTrace;

};

} // namespace ns3

#endif /* WIFI_MAC_H */