ctrl-headers.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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: Mirko Banchi <mk.banchi@gmail.com>
 */
 
#ifndef CTRL_HEADERS_H
#define CTRL_HEADERS_H
 
#include <list>
#include <vector>
#include "ns3/header.h"
#include "block-ack-type.h"
#include "ns3/he-ru.h"
#include "ns3/mac48-address.h"
 
namespace ns3 {
 
class WifiTxVector;
enum AcIndex : uint8_t;
 
class CtrlBAckRequestHeader : public Header
{
public:
  CtrlBAckRequestHeader ();
  ~CtrlBAckRequestHeader ();
  static TypeId GetTypeId (void);
 
  TypeId GetInstanceTypeId (void) const override;
  void Print (std::ostream &os) const override;
  uint32_t GetSerializedSize (void) const override;
  void Serialize (Buffer::Iterator start) const override;
  uint32_t Deserialize (Buffer::Iterator start) override;
 
  void SetHtImmediateAck (bool immediateAck);
  void SetType (BlockAckReqType type);
  void SetTidInfo (uint8_t tid);
  void SetStartingSequence (uint16_t seq);
 
  bool MustSendHtImmediateAck (void) const;
  BlockAckReqType GetType (void) const;
  uint8_t GetTidInfo (void) const;
  uint16_t GetStartingSequence (void) const;
  bool IsBasic (void) const;
  bool IsCompressed (void) const;
  bool IsExtendedCompressed (void) const;
  bool IsMultiTid (void) const;
 
  uint16_t GetStartingSequenceControl (void) const;
 
 
private:
  void SetStartingSequenceControl (uint16_t seqControl);
  uint16_t GetBarControl (void) const;
  void SetBarControl (uint16_t bar);
 
  bool m_barAckPolicy;       
  BlockAckReqType m_barType; 
  uint16_t m_tidInfo;        
  uint16_t m_startingSeq;    
};
 
 
class CtrlBAckResponseHeader : public Header
{
public:
  CtrlBAckResponseHeader ();
  ~CtrlBAckResponseHeader ();
  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);
 
  void SetHtImmediateAck (bool immediateAck);
  void SetType (BlockAckType type);
  void SetTidInfo (uint8_t tid, std::size_t index = 0);
  void SetStartingSequence (uint16_t seq, std::size_t index = 0);
 
  bool MustSendHtImmediateAck (void) const;
  BlockAckType GetType (void) const;
  uint8_t GetTidInfo (std::size_t index = 0) const;
  uint16_t GetStartingSequence (std::size_t index = 0) const;
  bool IsBasic (void) const;
  bool IsCompressed (void) const;
  bool IsExtendedCompressed (void) const;
  bool IsMultiTid (void) const;
  bool IsMultiSta (void) const;
 
  void SetAid11 (uint16_t aid, std::size_t index);
  uint16_t GetAid11 (std::size_t index) const;
  void SetAckType (bool type, std::size_t index);
  bool GetAckType (std::size_t index) const;
  void SetUnassociatedStaAddress (const Mac48Address& ra, std::size_t index);
  Mac48Address GetUnassociatedStaAddress (std::size_t index) const;
  std::size_t GetNPerAidTidInfoSubfields (void) const;
  std::vector<uint32_t> FindPerAidTidInfoWithAid (uint16_t aid) const;
 
  void SetReceivedPacket (uint16_t seq, std::size_t index = 0);
  void SetReceivedFragment (uint16_t seq, uint8_t frag);
  bool IsPacketReceived (uint16_t seq, std::size_t index = 0) const;
  bool IsFragmentReceived (uint16_t seq, uint8_t frag) const;
 
  uint16_t GetStartingSequenceControl (std::size_t index = 0) const;
  void SetStartingSequenceControl (uint16_t seqControl, std::size_t index = 0);
  const std::vector<uint8_t>& GetBitmap (std::size_t index = 0) const;
 
  void ResetBitmap (std::size_t index = 0);
 
 
private:
  uint16_t GetBaControl (void) const;
  void SetBaControl (uint16_t ba);
 
  Buffer::Iterator SerializeBitmap (Buffer::Iterator start, std::size_t index = 0) const;
  Buffer::Iterator DeserializeBitmap (Buffer::Iterator start, std::size_t index = 0);
 
  uint16_t IndexInBitmap (uint16_t seq, std::size_t index = 0) const;
 
  bool IsInBitmap (uint16_t seq, std::size_t index = 0) const;
 
  bool m_baAckPolicy;             
  BlockAckType m_baType;          
  uint16_t m_tidInfo;             
 
  struct BaInfoInstance
    {
      uint16_t m_aidTidInfo;          
      uint16_t m_startingSeq;         
      std::vector<uint8_t> m_bitmap;  
      Mac48Address m_ra;              
    };
 
  std::vector<BaInfoInstance> m_baInfo;    
};
 
 
enum TriggerFrameType : uint8_t
{
  BASIC_TRIGGER = 0,       // Basic
  BFRP_TRIGGER = 1,        // Beamforming Report Poll
  MU_BAR_TRIGGER = 2,      // Multi-User Block Ack Request
  MU_RTS_TRIGGER = 3,      // Multi-User Request To Send
  BSRP_TRIGGER = 4,        // Buffer Status Report Poll
  GCR_MU_BAR_TRIGGER = 5,  // Groupcast with Retries MU-BAR
  BQRP_TRIGGER = 6,        // Bandwidth Query Report Poll
  NFRP_TRIGGER = 7         // NDP Feedback Report Poll
};
 
 
class CtrlTriggerUserInfoField
{
public:
  CtrlTriggerUserInfoField (uint8_t triggerType);
  CtrlTriggerUserInfoField& operator= (const CtrlTriggerUserInfoField& userInfo);
  ~CtrlTriggerUserInfoField ();
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  Buffer::Iterator Serialize (Buffer::Iterator start) const;
  Buffer::Iterator Deserialize (Buffer::Iterator start);
  TriggerFrameType GetType (void) const;
  void SetAid12 (uint16_t aid);
  uint16_t GetAid12 (void) const;
  bool HasRaRuForAssociatedSta (void) const;
  bool HasRaRuForUnassociatedSta (void) const;
  void SetRuAllocation (HeRu::RuSpec ru);
  HeRu::RuSpec GetRuAllocation (void) const;
  void SetUlFecCodingType (bool ldpc);
  bool GetUlFecCodingType (void) const;
  void SetUlMcs (uint8_t mcs);
  uint8_t GetUlMcs (void) const;
  void SetUlDcm (bool dcm);
  bool GetUlDcm (void) const;
  void SetSsAllocation (uint8_t startingSs, uint8_t nSs);
  uint8_t GetStartingSs (void) const;
  uint8_t GetNss (void) const;
  void SetRaRuInformation (uint8_t nRaRu, bool moreRaRu);
  uint8_t GetNRaRus (void) const;
  bool GetMoreRaRu (void) const;
  void SetUlTargetRssiMaxTxPower (void);
  void SetUlTargetRssi (int8_t dBm);
  bool IsUlTargetRssiMaxTxPower (void) const;
  int8_t GetUlTargetRssi (void) const;
  void SetBasicTriggerDepUserInfo (uint8_t spacingFactor, uint8_t tidLimit, AcIndex prefAc);
  uint8_t GetMpduMuSpacingFactor (void) const;
  uint8_t GetTidAggregationLimit (void) const;
  AcIndex GetPreferredAc (void) const;
  void SetMuBarTriggerDepUserInfo (const CtrlBAckRequestHeader& bar);
   const CtrlBAckRequestHeader& GetMuBarTriggerDepUserInfo (void) const;
 
private:
  uint16_t m_aid12;   
  uint8_t m_ruAllocation;   
  bool m_ulFecCodingType;   
  uint8_t m_ulMcs;   
  bool m_ulDcm;   
  union
  {
    struct
    {
      uint8_t startingSs;   
      uint8_t nSs;   
    } ssAllocation;   
    struct
    {
      uint8_t nRaRu;   
      bool moreRaRu;   
    } raRuInformation;   
  } m_bits26To31;   
  uint8_t m_ulTargetRssi;   
  uint8_t m_triggerType; 
  uint8_t m_basicTriggerDependentUserInfo;   
  CtrlBAckRequestHeader m_muBarTriggerDependentUserInfo;   
};
 
 
class CtrlTriggerHeader : public Header
{
public:
  CtrlTriggerHeader ();
  CtrlTriggerHeader (TriggerFrameType type, const WifiTxVector& txVector);
  ~CtrlTriggerHeader ();
  CtrlTriggerHeader& operator= (const CtrlTriggerHeader& trigger);
  static TypeId GetTypeId (void);
  TypeId GetInstanceTypeId (void) const;
  void Print (std::ostream &os) const;
  uint32_t GetSerializedSize (void) const;
  void Serialize (Buffer::Iterator start) const;
  uint32_t Deserialize (Buffer::Iterator start);
 
  void SetType (TriggerFrameType type);
  TriggerFrameType GetType (void) const;
  const char * GetTypeString (void) const;
  static const char * GetTypeString (TriggerFrameType type);
  bool IsBasic (void) const;
  bool IsBfrp (void) const;
  bool IsMuBar (void) const;
  bool IsMuRts (void) const;
  bool IsBsrp (void) const;
  bool IsGcrMuBar (void) const;
  bool IsBqrp (void) const;
  bool IsNfrp (void) const;
  void SetUlLength (uint16_t len);
  uint16_t GetUlLength (void) const;
  WifiTxVector GetHeTbTxVector (uint16_t staId) const;
  void SetMoreTF (bool more);
  bool GetMoreTF (void) const;
  void SetCsRequired (bool cs);
  bool GetCsRequired (void) const;
  void SetUlBandwidth (uint16_t bw);
  uint16_t GetUlBandwidth (void) const;
  void SetGiAndLtfType (uint16_t guardInterval, uint8_t ltfType);
  uint16_t GetGuardInterval (void) const;
  uint8_t GetLtfType (void) const;
  void SetApTxPower (int8_t power);
  int8_t GetApTxPower (void) const;
  void SetUlSpatialReuse (uint16_t sr);
  uint16_t GetUlSpatialReuse (void) const;
  CtrlTriggerHeader GetCommonInfoField (void) const;
 
  CtrlTriggerUserInfoField& AddUserInfoField (void);
  CtrlTriggerUserInfoField& AddUserInfoField (const CtrlTriggerUserInfoField& userInfo);
 
  typedef std::list<CtrlTriggerUserInfoField>::const_iterator ConstIterator;
 
  typedef std::list<CtrlTriggerUserInfoField>::iterator Iterator;
 
  ConstIterator begin (void) const;
  ConstIterator end (void) const;
  Iterator begin (void);
  Iterator end (void);
  std::size_t GetNUserInfoFields (void) const;
  ConstIterator FindUserInfoWithAid (ConstIterator start, uint16_t aid12) const;
  ConstIterator FindUserInfoWithAid (uint16_t aid12) const;
  ConstIterator FindUserInfoWithRaRuAssociated (ConstIterator start) const;
  ConstIterator FindUserInfoWithRaRuAssociated (void) const;
  ConstIterator FindUserInfoWithRaRuUnassociated (ConstIterator start) const;
  ConstIterator FindUserInfoWithRaRuUnassociated (void) const;
  bool IsValid (void) const;
 
private:
  uint8_t m_triggerType;       
  uint16_t m_ulLength;         
  bool m_moreTF;               
  bool m_csRequired;           
  uint8_t m_ulBandwidth;       
  uint8_t m_giAndLtfType;      
  uint8_t m_apTxPower;         
  uint16_t m_ulSpatialReuse;   
  std::list<CtrlTriggerUserInfoField> m_userInfoFields;   
};
 
} //namespace ns3
 
#endif /* CTRL_HEADERS_H */