wifi-net-device.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005,2006 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#ifndef WIFI_NET_DEVICE_H
#define WIFI_NET_DEVICE_H
 
#include "wifi-standards.h"
 
#include "ns3/net-device.h"
#include "ns3/traced-callback.h"
 
#include <optional>
#include <vector>
 
namespace ns3
{
 
class WifiRemoteStationManager;
class WifiPhy;
class WifiMac;
class HtConfiguration;
class VhtConfiguration;
class HeConfiguration;
class EhtConfiguration;
 
/**
 * @defgroup wifi Wifi Models
 *
 * This section documents the API of the ns-3 Wifi module. For a generic functional description,
 * please refer to the ns-3 manual.
 */
 
/**
 * @brief Hold together all Wifi-related objects.
 * @ingroup wifi
 *
 * This class holds together ns3::Channel, ns3::WifiPhy,
 * ns3::WifiMac, and, ns3::WifiRemoteStationManager.
 */
class WifiNetDevice : public NetDevice
{
  public:
    /**
     * @brief Get the type ID.
     * @return the object TypeId
     */
    static TypeId GetTypeId();
 
    WifiNetDevice();
    ~WifiNetDevice() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    WifiNetDevice(const WifiNetDevice& o) = delete;
    WifiNetDevice& operator=(const WifiNetDevice&) = delete;
 
    /**
     * Set the Wifi standard.
     *
     * @param standard the Wifi standard
     */
    void SetStandard(WifiStandard standard);
    /**
     * Get the Wifi standard.
     *
     * @return the Wifi standard
     */
    WifiStandard GetStandard() const;
 
    /**
     * @param mac the MAC layer to use.
     */
    void SetMac(const Ptr<WifiMac> mac);
    /**
     * @param phy the PHY layer to use.
     */
    void SetPhy(const Ptr<WifiPhy> phy);
    /**
     * @param phys the PHY layers to use (for 11be multi-link devices only)
     */
    void SetPhys(const std::vector<Ptr<WifiPhy>>& phys);
    /**
     * @param manager the manager to use.
     */
    void SetRemoteStationManager(const Ptr<WifiRemoteStationManager> manager);
    /**
     * @param managers the managers to use (for 11be multi-link devices only)
     */
    void SetRemoteStationManagers(const std::vector<Ptr<WifiRemoteStationManager>>& managers);
    /**
     * @returns the MAC we are currently using.
     */
    Ptr<WifiMac> GetMac() const;
    /**
     * @returns the PHY we are currently using.
     *
     * This GetPhy variant is needed to keep using "Phy" in the path names.
     */
    Ptr<WifiPhy> GetPhy() const;
    /**
     * @param i the index (starting at 0) of the PHY object to retrieve
     * @returns the requested PHY object
     */
    virtual Ptr<WifiPhy> GetPhy(uint8_t i) const;
    /**
     * @returns a const reference to the vector of PHY objects
     */
    virtual const std::vector<Ptr<WifiPhy>>& GetPhys() const;
    /**
     * @returns the number of PHY objects
     */
    uint8_t GetNPhys() const;
    /**
     * @returns the remote station manager we are currently using.
     *
     * This GetRemoteStationManager variant is needed to keep using "RemoteStationManager"
     * in the path names.
     */
    Ptr<WifiRemoteStationManager> GetRemoteStationManager() const;
    /**
     * @param linkId the ID (starting at 0) of the link of the RemoteStationManager
     *               object to retrieve
     * @returns the requested remote station manager
     */
    Ptr<WifiRemoteStationManager> GetRemoteStationManager(uint8_t linkId) const;
    /**
     * @returns a const reference to the vector of remote station managers
     */
    virtual const std::vector<Ptr<WifiRemoteStationManager>>& GetRemoteStationManagers() const;
    /**
     * @returns the number of remote station managers
     */
    uint8_t GetNRemoteStationManagers() const;
 
    /**
     * @param htConfiguration pointer to HtConfiguration
     */
    void SetHtConfiguration(Ptr<HtConfiguration> htConfiguration);
    /**
     * @return pointer to HtConfiguration if it exists
     */
    Ptr<HtConfiguration> GetHtConfiguration() const;
    /**
     * @param vhtConfiguration pointer to VhtConfiguration
     */
    void SetVhtConfiguration(Ptr<VhtConfiguration> vhtConfiguration);
    /**
     * @return pointer to VhtConfiguration if it exists
     */
    Ptr<VhtConfiguration> GetVhtConfiguration() const;
    /**
     * @param heConfiguration pointer to HeConfiguration
     */
    void SetHeConfiguration(Ptr<HeConfiguration> heConfiguration);
    /**
     * @return pointer to HeConfiguration if it exists
     */
    Ptr<HeConfiguration> GetHeConfiguration() const;
    /**
     * @param ehtConfiguration pointer to EhtConfiguration
     */
    void SetEhtConfiguration(Ptr<EhtConfiguration> ehtConfiguration);
    /**
     * @return pointer to EhtConfiguration if it exists
     */
    Ptr<EhtConfiguration> GetEhtConfiguration() const;
 
    void SetIfIndex(const uint32_t index) override;
    uint32_t GetIfIndex() const override;
    Ptr<Channel> GetChannel() const override;
    void SetAddress(Address address) override;
    Address GetAddress() const override;
    bool SetMtu(const uint16_t mtu) override;
    uint16_t GetMtu() const override;
    bool IsLinkUp() const override;
    void AddLinkChangeCallback(Callback<void> callback) override;
    bool IsBroadcast() const override;
    Address GetBroadcast() const override;
    bool IsMulticast() const override;
    Address GetMulticast(Ipv4Address multicastGroup) const override;
    bool IsPointToPoint() const override;
    bool IsBridge() const override;
    bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber) override;
    Ptr<Node> GetNode() const override;
    void SetNode(const Ptr<Node> node) override;
    bool NeedsArp() const override;
    void SetReceiveCallback(NetDevice::ReceiveCallback cb) override;
    Address GetMulticast(Ipv6Address addr) const override;
    bool SendFrom(Ptr<Packet> packet,
                  const Address& source,
                  const Address& dest,
                  uint16_t protocolNumber) override;
    void SetPromiscReceiveCallback(PromiscReceiveCallback cb) override;
    bool SupportsSendFrom() const override;
 
  protected:
    void DoDispose() override;
    void DoInitialize() override;
    /**
     * Receive a packet from the lower layer and pass the
     * packet up the stack.
     *
     * @param packet the packet to forward up
     * @param from the source address
     * @param to the destination address
     */
    void ForwardUp(Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
 
  private:
    /**
     * Set that the link is up. A link is always up in ad-hoc mode.
     * For a STA, a link is up when the STA is associated with an AP.
     */
    void LinkUp();
    /**
     * Set that the link is down (i.e. STA is not associated).
     */
    void LinkDown();
    /**
     * Complete the configuration of this Wi-Fi device by
     * connecting all lower components (e.g. MAC, WifiRemoteStation) together.
     */
    void CompleteConfig();
 
    /**
     * Send a packet
     *
     * @param packet packet sent from upper layers
     * @param source source mac address (if provided)
     * @param dest destination mac address
     * @param protocolNumber type of payload contained in this packet
     * @returns true if successful, false otherwise
     */
    bool DoSend(Ptr<Packet> packet,
                std::optional<Address> source,
                const Address& dest,
                uint16_t protocolNumber);
 
    Ptr<Node> m_node;                                             //!< the node
    std::vector<Ptr<WifiPhy>> m_phys;                             //!< the phy objects
    Ptr<WifiMac> m_mac;                                           //!< the MAC
    std::vector<Ptr<WifiRemoteStationManager>> m_stationManagers; //!< the station managers
    Ptr<HtConfiguration> m_htConfiguration;                       //!< the HtConfiguration
    Ptr<VhtConfiguration> m_vhtConfiguration;                     //!< the VhtConfiguration
    Ptr<HeConfiguration> m_heConfiguration;                       //!< the HeConfiguration
    Ptr<EhtConfiguration> m_ehtConfiguration;                     //!< the EhtConfiguration
    NetDevice::ReceiveCallback m_forwardUp;                       //!< forward up callback
    NetDevice::PromiscReceiveCallback m_promiscRx;                //!< promiscuous receive callback
 
    TracedCallback<Ptr<const Packet>, Mac48Address> m_rxLogger; //!< receive trace callback
    TracedCallback<Ptr<const Packet>, Mac48Address> m_txLogger; //!< transmit trace callback
 
    WifiStandard m_standard;        //!< Wifi standard
    uint32_t m_ifIndex;             //!< IF index
    bool m_linkUp;                  //!< link up
    TracedCallback<> m_linkChanges; //!< link change callback
    mutable uint16_t m_mtu;         //!< MTU
    bool m_configComplete;          //!< configuration complete
};
 
} // namespace ns3
 
#endif /* WIFI_NET_DEVICE_H */