/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2005, 2006 INRIA

 * Copyright (c) 2009 MIRKO BANCHI

 *

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

 * Author: Mirko Banchi <mk.banchi@gmail.com>

 */

#ifndef MAC_LOW_H

#define MAC_LOW_H

#include <vector>

#include <stdint.h>

#include <ostream>

#include <map>

#include "wifi-mac-header.h"

#include "wifi-mode.h"

#include "wifi-preamble.h"

#include "wifi-remote-station-manager.h"

#include "ctrl-headers.h"

#include "mgt-headers.h"

#include "block-ack-agreement.h"

#include "ns3/mac48-address.h"

#include "ns3/callback.h"

#include "ns3/event-id.h"

#include "ns3/packet.h"

#include "ns3/nstime.h"

#include "qos-utils.h"

#include "block-ack-cache.h"

namespace ns3 {

class WifiPhy;

class WifiMac;

class EdcaTxopN;

/**

 * \brief listen to events coming from ns3::MacLow.

 */

class MacLowTransmissionListener {

public:

  MacLowTransmissionListener ();

  virtual ~MacLowTransmissionListener ();

  /**

   * \param snr the snr of the cts

   * \param txMode the txMode of the cts

   *

   * ns3::MacLow received an expected CTS within

   * CtsTimeout.

   */

  virtual void GotCts (double snr, WifiMode txMode) = 0;

  /**

   * ns3::MacLow did not receive an expected CTS

   * within CtsTimeout.

   */

  virtual void MissedCts (void) = 0;

  /**

   * \param snr the snr of the ack

   * \param txMode the transmission mode of the ack

   *

   * ns3::MacLow received an expected ACL within

   * AckTimeout. The <i>snr</i> and <i>txMode</i>

   * arguments are not valid when SUPER_FAST_ACK is 

   * used.

   */

  virtual void GotAck (double snr, WifiMode txMode) = 0;

  /**

   * ns3::MacLow did not receive an expected ACK within

   * AckTimeout.

   */

  virtual void MissedAck (void) = 0;

  /**

   * \param blockAck Block ack response header

   * \param source Address of block ack sender

   *

   * Invoked when ns3::MacLow receives a block ack frame.

   * Block ack frame is received after a block ack request

   * and contains information about the correct reception 

   * of a set of packet for which a normal ack wasn't send.

   * Default implementation for this method is empty. Every

   * queue that intends to be notified by MacLow of reception

   * of a block ack must redefine this function.

   */

  virtual void GotBlockAck (const CtrlBAckResponseHeader *blockAck, Mac48Address source);

  /**

   * ns3::MacLow did not receive an expected BLOCK_ACK within

   * BlockAckTimeout. This method is used only for immediate 

   * block ack variant. With delayed block ack, the MissedAck method will be

   * called instead: upon receipt of a block ack request, the rx station will

   * reply with a normal ack frame. Later, when the rx station gets a txop, it

   * will send the block ack back to the tx station which will reply with a

   * normal ack to the rx station.

   */

  virtual void MissedBlockAck (void);

  /**

   * Invoked when ns3::MacLow wants to start a new transmission

   * as configured by MacLowTransmissionParameters::EnableNextData.

   * The listener is expected to call again MacLow::StartTransmission

   * with the "next" data to send.

   */

  virtual void StartNext (void) = 0;

  /**

   * Invoked if this transmission was canceled 

   * one way or another. When this method is invoked,

   * you can assume that the packet has not been passed

   * down the stack to the PHY.

   */

  virtual void Cancel (void) = 0;

};

/**

 * \brief listen to NAV events

 *

 * This class is typically connected to an instance of ns3::Dcf

 * and calls to its methods are forwards to the corresponding

 * ns3::Dcf methods.

 */

class MacLowDcfListener {

public:

  MacLowDcfListener ();

  virtual ~MacLowDcfListener ();

  /**

   * \param duration duration of NAV timer

   */

  virtual void NavStart (Time duration) = 0;

  /**

   * \param duration duration of NAV timer

   */

  virtual void NavReset (Time duration) = 0;

  virtual void AckTimeoutStart (Time duration) = 0;

  virtual void AckTimeoutReset () = 0;

  virtual void CtsTimeoutStart (Time duration) = 0;

  virtual void CtsTimeoutReset () = 0;

};

/**

 * \brief listen for block ack events.

 */

class MacLowBlockAckEventListener {

public:

  MacLowBlockAckEventListener ();

  virtual ~MacLowBlockAckEventListener ();

  /**

   * Typically is called in order to notify EdcaTxopN that a block ack inactivity

   * timeout occurs for the block ack agreement identified by the pair <i>originator</i>, <i>tid</i>.

   * 

   * Rx station maintains an inactivity timer for each block ack

   * agreement. Timer is reset when a frame with ack policy block ack

   * or a block ack request are received. When this timer reaches zero

   * this method is called and a delba frame is scheduled for transmission.

   */

  virtual void BlockAckInactivityTimeout (Mac48Address originator, uint8_t tid) = 0;

};

/**

 * \brief control how a packet is transmitted.

 *

 * The ns3::MacLow::StartTransmission method expects

 * an instance of this class to describe how the packet

 * should be transmitted.

 */

class MacLowTransmissionParameters {

public:

  MacLowTransmissionParameters ();

  /**

   * Wait ACKTimeout for an ACK. If we get an ACK

   * on time, call MacLowTransmissionListener::GotAck.

   * Call MacLowTransmissionListener::MissedAck otherwise.

   */

  void EnableAck (void);

  /**

   *   - wait PIFS after end-of-tx. If idle, call

   *     MacLowTransmissionListener::MissedAck.

   *   - if busy at end-of-tx+PIFS, wait end-of-rx

   *   - if Ack ok at end-of-rx, call 

   *     MacLowTransmissionListener::GotAck.

   *   - if Ack not ok at end-of-rx, report call 

   *     MacLowTransmissionListener::MissedAck

   *     at end-of-rx+SIFS.

   *

   * This is really complicated but it is needed for

   * proper HCCA support.

   */

  void EnableFastAck (void);

  /** 

   *  - if busy at end-of-tx+PIFS, call 

   *    MacLowTransmissionListener::GotAck

   *  - if idle at end-of-tx+PIFS, call

   *    MacLowTransmissionListener::MissedAck

   */

  void EnableSuperFastAck (void);

  /**

   * Wait BASICBLOCKACKTimeout for a Basic Block Ack Response frame.

   */

  void EnableBasicBlockAck (void);

  /**

   * Wait COMPRESSEDBLOCKACKTimeout for a Compressed Block Ack Response frame.

   */

  void EnableCompressedBlockAck (void);

  /**

   * NOT IMPLEMENTED FOR NOW

   */

  void EnableMultiTidBlockAck (void);

  /**

   * Send a RTS, and wait CTSTimeout for a CTS. If we get a 

   * CTS on time, call MacLowTransmissionListener::GotCts

   * and send data. Otherwise, call MacLowTransmissionListener::MissedCts

   * and do not send data.

   */

  void EnableRts (void);

  /**

   * \param size size of next data to send after current packet is

   *        sent.

   *

   * Add the transmission duration of the next data to the 

   * durationId of the outgoing packet and call 

   * MacLowTransmissionListener::StartNext at the end of 

   * the current transmission + SIFS.

   */

  void EnableNextData (uint32_t size);

  /**

   * \param durationId the value to set in the duration/Id field of

   *        the outgoing packet.

   *

   * Ignore all other durationId calculation and simply force the 

   * packet's durationId field to this value.

   */

  void EnableOverrideDurationId (Time durationId);

  /**

   * Do not wait for Ack after data transmission. Typically

   * used for Broadcast and multicast frames.

   */

  void DisableAck (void);

  /**

   * Do not send rts and wait for cts before sending data.

   */

  void DisableRts (void);

  /**

   * Do not attempt to send data burst after current transmission

   */

  void DisableNextData (void);

  /**

   * Do not force the duration/id field of the packet: its

   * value is automatically calculated by the MacLow before

   * calling WifiPhy::Send.

   */

  void DisableOverrideDurationId (void);

  /**

   * \returns true if must wait for ACK after data transmission,

   *          false otherwise.

   *

   * This methods returns true when any of MustWaitNormalAck,

   * MustWaitFastAck, or MustWaitSuperFastAck return true.

   */

  bool MustWaitAck (void) const;

  /**

   * \returns true if normal ACK protocol should be used, false

   *          otherwise.

   *

   * \sa EnableAck

   */

  bool MustWaitNormalAck (void) const;

  /**

   * \returns true if fast ack protocol should be used, false 

   *          otherwise.

   *

   * \sa EnableFastAck

   */

  bool MustWaitFastAck (void) const;

  /**

   * \returns true if super fast ack protocol should be used, false 

   *          otherwise.

   *

   * \sa EnableSuperFastAck

   */

  bool MustWaitSuperFastAck (void) const;

  /**

   * \returns true if block ack mechanism is used, false otherwise.

   *

   * \sa EnableBlockAck

   */

  bool MustWaitBasicBlockAck (void) const;

  /**

   * \returns true if compressed block ack mechanism is used, false otherwise.

   *

   * \sa EnableCompressedBlockAck

   */

  bool MustWaitCompressedBlockAck (void) const;

  /**

   * \returns true if multi-tid block ack mechanism is used, false otherwise.

   *

   * \sa EnableMultiTidBlockAck

   */

  bool MustWaitMultiTidBlockAck (void) const;

  /**

   * \returns true if RTS should be sent and CTS waited for before 

   *          sending data, false otherwise.

   */

  bool MustSendRts (void) const;

  /**

   * \returns true if a duration/id was forced with 

   *         EnableOverrideDurationId, false otherwise.

   */

  bool HasDurationId (void) const;

  /**

   * \returns the duration/id forced by EnableOverrideDurationId

   */

  Time GetDurationId (void) const;

  /**

   * \returns true if EnableNextData was called, false otherwise.

   */

  bool HasNextPacket (void) const;

  /**

   * \returns the size specified by EnableNextData.

   */

  uint32_t GetNextPacketSize (void) const;

private:

  friend std::ostream &operator << (std::ostream &os, const MacLowTransmissionParameters &params);

  uint32_t m_nextSize;

  enum {

    ACK_NONE,

    ACK_NORMAL,

    ACK_FAST,

    ACK_SUPER_FAST,

    BLOCK_ACK_BASIC,

    BLOCK_ACK_COMPRESSED,

    BLOCK_ACK_MULTI_TID

  } m_waitAck;

  bool m_sendRts;

  Time m_overrideDurationId;

};

std::ostream &operator << (std::ostream &os, const MacLowTransmissionParameters &params);

/**

 * \brief handle RTS/CTS/DATA/ACK transactions.

 */

class MacLow : public Object {

public:

  typedef Callback<void, Ptr<Packet>, const WifiMacHeader*> MacLowRxCallback;

  MacLow ();

  virtual ~MacLow ();

  void SetPhy (Ptr<WifiPhy> phy);

  void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> manager);

  void SetAddress (Mac48Address ad);

  void SetAckTimeout (Time ackTimeout);

  void SetBasicBlockAckTimeout (Time blockAckTimeout);

  void SetCompressedBlockAckTimeout (Time blockAckTimeout);

  void SetCtsTimeout (Time ctsTimeout);

  void SetSifs (Time sifs);

  void SetSlotTime (Time slotTime);

  void SetPifs (Time pifs);

  void SetBssid (Mac48Address ad);

  Mac48Address GetAddress (void) const;

  Time GetAckTimeout (void) const;

  Time GetBasicBlockAckTimeout () const;

  Time GetCompressedBlockAckTimeout () const;

  Time GetCtsTimeout (void) const;

  Time GetSifs (void) const;

  Time GetSlotTime (void) const;

  Time GetPifs (void) const;

  Mac48Address GetBssid (void) const;

  /**

   * \param callback the callback which receives every incoming packet.

   *

   * This callback typically forwards incoming packets to

   * an instance of ns3::MacRxMiddle.

   */

  void SetRxCallback (Callback<void,Ptr<Packet>,const WifiMacHeader *> callback);

  /**

   * \param listener listen to NAV events for every incoming

   *        and outgoing packet.

   */

  void RegisterDcfListener (MacLowDcfListener *listener);

  /**

   * \param packet to send (does not include the 802.11 MAC header and checksum)

   * \param hdr header associated to the packet to send.

   * \param parameters transmission parameters of packet.

   *

   * This transmission time includes the time required for

   * the next packet transmission if one was selected.

   */

  Time CalculateTransmissionTime (Ptr<const Packet> packet,

                                  const WifiMacHeader* hdr, 

                                  const MacLowTransmissionParameters& parameters) const;

  /**

   * \param packet packet to send

   * \param hdr 802.11 header for packet to send

   * \param parameters the transmission parameters to use for this packet.

   * \param listener listen to transmission events.

   *

   * Start the transmission of the input packet and notify the listener

   * of transmission events.

   */

  void StartTransmission (Ptr<const Packet> packet, 

                          const WifiMacHeader* hdr, 

                          MacLowTransmissionParameters parameters,

                          MacLowTransmissionListener *listener);

  /**

   * \param packet packet received

   * \param rxSnr snr of packet received

   * \param txMode transmission mode of packet received

   * \param preamble type of preamble used for the packet received

   *

   * This method is typically invoked by the lower PHY layer to notify

   * the MAC layer that a packet was successfully received.

   */

  void ReceiveOk (Ptr<Packet> packet, double rxSnr, WifiMode txMode, WifiPreamble preamble);

  /**

   * \param packet packet received.

   * \param rxSnr snr of packet received.

   *

   * This method is typically invoked by the lower PHY layer to notify

   * the MAC layer that a packet was unsuccessfully received.

   */

  void ReceiveError (Ptr<const Packet> packet, double rxSnr);

  /**

   * \param duration switching delay duration.

   *

   * This method is typically invoked by the PhyMacLowListener to notify

   * the MAC layer that a channel switching occured. When a channel switching

   * occurs, pending MAC transmissions (RTS, CTS, DATA and ACK) are cancelled.

   */

  void NotifySwitchingStartNow (Time duration); 

  /**

   * \param respHdr Add block ack response from originator (action

   * frame).

   * \param originator Address of peer station involved in block ack

   * mechanism.

   * \param startingSeq Sequence number of the first MPDU of all

   * packets for which block ack was negotiated.

   *

   * This function is typically invoked only by ns3::RegularWifiMac

   * when the STA (which may be non-AP in ESS, or in an IBSS) has

   * received an ADDBA Request frame and is transmitting an ADDBA

   * Response frame. At this point MacLow must allocate buffers to

   * collect all correctly received packets belonging to the category

   * for which Block Ack was negotiated.

   */

  void CreateBlockAckAgreement (const MgtAddBaResponseHeader *respHdr,

                                Mac48Address originator,

                                uint16_t startingSeq);

  /**

   * \param originator Address of peer participating in Block Ack mechanism.

   * \param tid TID for which Block Ack was created.

   *

   * Checks if exists an established block ack agreement with <i>originator</i>

   * for tid <i>tid</i>. If the agreement exists, tears down it. This function is typically

   * invoked when a DELBA frame is received from <i>originator</i>.

   */

  void DestroyBlockAckAgreement (Mac48Address originator, uint8_t tid);

  /**

   * \param ac Access class managed by the queue.

   * \param listener The listener for the queue.

   *

   * The lifetime of the registered listener is typically equal to the lifetime of the queue

   * associated to this AC.

   */

  void RegisterBlockAckListenerForAc (enum AcIndex ac, MacLowBlockAckEventListener *listener);

private:

  void CancelAllEvents (void);

  uint32_t GetAckSize (void) const;

  uint32_t GetBlockAckSize (enum BlockAckType type) const;