/*
 * Copyright (c) 2010
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 */

#ifndef ALOHA_NOACK_NET_DEVICE_H
#define ALOHA_NOACK_NET_DEVICE_H

#include "ns3/queue-fwd.h"
#include <ns3/address.h>
#include <ns3/callback.h>
#include <ns3/generic-phy.h>
#include <ns3/mac48-address.h>
#include <ns3/net-device.h>
#include <ns3/node.h>
#include <ns3/nstime.h>
#include <ns3/packet.h>
#include <ns3/ptr.h>
#include <ns3/traced-callback.h>

#include <cstring>

namespace ns3
{

class SpectrumChannel;
class Channel;
class SpectrumErrorModel;

/**
 * \ingroup spectrum
 *
 * This devices implements the following features:
 *  - layer 3 protocol multiplexing
 *  - MAC addressing
 *  - Aloha MAC:
 *    + packets transmitted as soon as possible
 *    + a new packet is queued if previous one is still being transmitted
 *    + no acknowledgements, hence no retransmissions
 *  - can support any PHY layer compatible with the API defined in generic-phy.h
 *
 */
class AlohaNoackNetDevice : public NetDevice
{
  public:
    /**
     * State of the NetDevice
     */
    enum State
    {
        IDLE, //!< Idle state
        TX,   //!< Transmitting state
        RX    //!< Receiving state
    };

    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();

    AlohaNoackNetDevice();
    ~AlohaNoackNetDevice() override;

    /**
     * set the queue which is going to be used by this device
     *
     * @param queue
     */
    virtual void SetQueue(Ptr<Queue<Packet>> queue);

    /**
     * Notify the MAC that the PHY has finished a previously started transmission
     *
     */
    void NotifyTransmissionEnd(Ptr<const Packet>);

    /**
     * Notify the MAC that the PHY has started a reception
     *
     */
    void NotifyReceptionStart();

    /**
     * Notify the MAC that the PHY finished a reception with an error
     *
     */
    void NotifyReceptionEndError();

    /**
     * Notify the MAC that the PHY finished a reception successfully
     *
     * @param p the received packet
     */
    void NotifyReceptionEndOk(Ptr<Packet> p);

    /**
     * This class doesn't talk directly with the underlying channel (a
     * dedicated PHY class is expected to do it), however the NetDevice
     * specification features a GetChannel() method. This method here
     * is therefore provide to allow AlohaNoackNetDevice::GetChannel() to have
     * something meaningful to return.
     *
     * @param c the underlying channel
     */
    void SetChannel(Ptr<Channel> c);

    /**
     * set the callback used to instruct the lower layer to start a TX
     *
     * @param c
     */
    void SetGenericPhyTxStartCallback(GenericPhyTxStartCallback c);

    /**
     * Set the Phy object which is attached to this device.
     * This object is needed so that we can set/get attributes and
     * connect to trace sources of the PHY from the net device.
     *
     * @param phy the Phy object attached to the device.  Note that the
     * API between the PHY and the above (this NetDevice which also
     * implements the MAC) is implemented entirely by
     * callbacks, so we do not require that the PHY inherits by any
     * specific class.
     */
    void SetPhy(Ptr<Object> phy);

    /**
     * @return a reference to the PHY object embedded in this NetDevice.
     */
    Ptr<Object> GetPhy() const;

    // inherited from NetDevice
    void SetIfIndex(const uint32_t index) override;
    uint32_t GetIfIndex() const override;
    Ptr<Channel> GetChannel() const override;
    bool SetMtu(const uint16_t mtu) override;
    uint16_t GetMtu() const override;
    void SetAddress(Address address) override;
    Address GetAddress() const override;
    bool IsLinkUp() const override;
    void AddLinkChangeCallback(Callback<void> callback) override;
    bool IsBroadcast() const override;
    Address GetBroadcast() const override;
    bool IsMulticast() const override;
    bool IsPointToPoint() const override;
    bool IsBridge() const override;
    bool Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber) override;
    bool SendFrom(Ptr<Packet> packet,
                  const Address& source,
                  const Address& dest,
                  uint16_t protocolNumber) override;
    Ptr<Node> GetNode() const override;
    void SetNode(Ptr<Node> node) override;
    bool NeedsArp() const override;
    void SetReceiveCallback(NetDevice::ReceiveCallback cb) override;
    Address GetMulticast(Ipv4Address addr) const override;
    Address GetMulticast(Ipv6Address addr) const override;
    void SetPromiscReceiveCallback(PromiscReceiveCallback cb) override;
    bool SupportsSendFrom() const override;

  private:
    /**
     * Notification of Guard Interval end.
     */
    void NotifyGuardIntervalEnd();
    void DoDispose() override;

    /**
     * start the transmission of a packet by contacting the PHY layer
     */
    void StartTransmission();

    Ptr<Queue<Packet>> m_queue; //!< packet queue

    TracedCallback<Ptr<const Packet>> m_macTxTrace;        //!< Tx trace
    TracedCallback<Ptr<const Packet>> m_macTxDropTrace;    //!< Tx Drop trace
    TracedCallback<Ptr<const Packet>> m_macPromiscRxTrace; //!< Promiscuous Rx trace
    TracedCallback<Ptr<const Packet>> m_macRxTrace;        //!< Rx trace

    Ptr<Node> m_node;       //!< Node owning this NetDevice
    Ptr<Channel> m_channel; //!< Channel

    Mac48Address m_address; //!< MAC address

    NetDevice::ReceiveCallback m_rxCallback;               //!< Rx callback
    NetDevice::PromiscReceiveCallback m_promiscRxCallback; //!< Promiscuous Rx callback

    GenericPhyTxStartCallback m_phyMacTxStartCallback; //!< Tx Start callback

    /**
     * List of callbacks to fire if the link changes state (up or down).
     */
    TracedCallback<> m_linkChangeCallbacks;

    uint32_t m_ifIndex;     //!< Interface index
    mutable uint32_t m_mtu; //!< NetDevice MTU
    bool m_linkUp;          //!< true if the link is up

    State m_state;            //!< State of the NetDevice
    Ptr<Packet> m_currentPkt; //!< Current packet
    Ptr<Object> m_phy;        //!< PHY object
};

} // namespace ns3

#endif /* ALOHA_NOACK_NET_DEVICE_H */
