wifi-mac.h

Go to the documentation of this file.

/* -*- 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/net-device.h"
#include "wifi-standards.h"
#include "wifi-remote-station-manager.h"
#include "qos-utils.h"

namespace ns3 {

class Ssid;
class Txop;
class HtConfiguration;
class VhtConfiguration;
class HeConfiguration;

enum TypeOfStation
{
  STA,
  AP,
  ADHOC_STA,
  MESH,
  OCB
};

enum WifiMacDropReason : uint8_t
{
  WIFI_MAC_DROP_FAILED_ENQUEUE = 0,
  WIFI_MAC_DROP_EXPIRED_LIFETIME,
  WIFI_MAC_DROP_REACHED_RETRY_LIMIT
};

class WifiMac : public Object
{
public:
  virtual void DoDispose ();

  static TypeId GetTypeId (void);

  void SetDevice (const Ptr<NetDevice> device);
  Ptr<NetDevice> GetDevice (void) const;

  virtual void SetTypeOfStation (TypeOfStation type) = 0;
  virtual TypeOfStation GetTypeOfStation (void) const = 0;

  virtual void SetSsid (Ssid ssid) = 0;
  virtual void SetShortSlotTimeSupported (bool enable) = 0;
  virtual void SetPromisc (void) = 0;

  virtual Mac48Address GetAddress (void) const = 0;
  virtual Ssid GetSsid (void) const = 0;
  virtual void SetAddress (Mac48Address address) = 0;
  virtual Mac48Address GetBssid (void) const = 0;
  virtual bool GetShortSlotTimeSupported (void) const = 0;

  virtual void Enqueue (Ptr<Packet> packet, Mac48Address to, Mac48Address from) = 0;
  virtual void Enqueue (Ptr<Packet> packet, Mac48Address to) = 0;
  virtual bool SupportsSendFrom (void) const = 0;
  virtual void SetWifiPhy (Ptr<WifiPhy> phy) = 0;
  virtual Ptr<WifiPhy> GetWifiPhy (void) const = 0;
  virtual void ResetWifiPhy (void) = 0;
  virtual void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager) = 0;
  virtual Ptr<WifiRemoteStationManager> GetWifiRemoteStationManager (void) const = 0;

  typedef Callback<void, Ptr<const Packet>, Mac48Address, Mac48Address> ForwardUpCallback;

  virtual void SetForwardUpCallback (ForwardUpCallback 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.
   */

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

  virtual void ConfigureStandard (WifiStandard standard) = 0;

  Ptr<HtConfiguration> GetHtConfiguration (void) const;
  Ptr<VhtConfiguration> GetVhtConfiguration (void) const;
  Ptr<HeConfiguration> GetHeConfiguration (void) const;


protected:
  void ConfigureDcf (Ptr<Txop> dcf, uint32_t cwmin, uint32_t cwmax, bool isDsss, AcIndex ac);


private:
  Ptr<NetDevice> m_device;    

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