wifi-phy-header.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2018 Sébastien Deronne
 *
 * 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: Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef WIFI_PHY_HEADER_H
#define WIFI_PHY_HEADER_H

#include "ns3/header.h"

namespace ns3 {

class DsssSigHeader : public Header
{
public:
  DsssSigHeader ();
  virtual ~DsssSigHeader ();

  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 SetRate (uint64_t rate);
  uint64_t GetRate (void) const;
  void SetLength (uint16_t length);
  uint16_t GetLength (void) const;


private:
  uint8_t m_rate;    
  uint16_t m_length; 
};


class LSigHeader : public Header
{
public:
  LSigHeader ();
  virtual ~LSigHeader ();

  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 SetRate (uint64_t rate, uint16_t channelWidth = 20);
  uint64_t GetRate (uint16_t channelWidth = 20) const;
  void SetLength (uint16_t length);
  uint16_t GetLength (void) const;


private:
  uint8_t m_rate;    
  uint16_t m_length; 
};


class HtSigHeader : public Header
{
public:
  HtSigHeader ();
  virtual ~HtSigHeader ();

  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 SetMcs (uint8_t mcs);
  uint8_t GetMcs (void) const;
  void SetChannelWidth (uint16_t channelWidth);
  uint16_t GetChannelWidth (void) const;
  void SetAggregation (bool aggregation);
  bool GetAggregation (void) const;
  void SetFecCoding (bool ldpc);
  bool IsLdpcFecCoding (void) const;
  void SetShortGuardInterval (bool sgi);
  bool GetShortGuardInterval (void) const;
  void SetHtLength (uint16_t length);
  uint16_t GetHtLength (void) const;


private:
  uint8_t m_mcs;         
  uint8_t m_cbw20_40;    
  uint16_t m_htLength;   
  uint8_t m_aggregation; 
  uint8_t m_fecCoding;   
  uint8_t m_sgi;         
};

class VhtSigHeader : public Header
{
public:
  VhtSigHeader ();
  virtual ~VhtSigHeader ();

  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 SetMuFlag (bool mu);

  void SetChannelWidth (uint16_t channelWidth);
  uint16_t GetChannelWidth (void) const;
  void SetNStreams (uint8_t nStreams);
  uint8_t GetNStreams (void) const;

  void SetShortGuardInterval (bool sgi);
  bool GetShortGuardInterval (void) const;
  void SetShortGuardIntervalDisambiguation (bool disambiguation);
  bool GetShortGuardIntervalDisambiguation (void) const;
  void SetCoding (bool ldpc);
  bool IsLdpcCoding (void) const;
  void SetSuMcs (uint8_t mcs);
  uint8_t GetSuMcs (void) const;


private:
  //VHT-SIG-A1 fields
  uint8_t m_bw;   
  uint8_t m_nsts; 

  //VHT-SIG-A2 fields
  uint8_t m_sgi;                
  uint8_t m_sgi_disambiguation; 
  uint8_t m_coding;             
  uint8_t m_suMcs;              

  bool m_mu;
  };


class HeSigHeader : public Header
{
public:
  HeSigHeader ();
  virtual ~HeSigHeader ();

  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 SetMuFlag (bool mu);

  void SetMcs (uint8_t mcs);
  uint8_t GetMcs (void) const;
  void SetBssColor (uint8_t bssColor);
  uint8_t GetBssColor (void) const;
  void SetChannelWidth (uint16_t channelWidth);
  uint16_t GetChannelWidth (void) const;
  void SetGuardIntervalAndLtfSize (uint16_t gi, uint8_t ltf);
  uint16_t GetGuardInterval (void) const;
  void SetNStreams (uint8_t nStreams);
  uint8_t GetNStreams (void) const;
  void SetCoding (bool ldpc);
  bool IsLdpcCoding (void) const;

private:
  //HE-SIG-A1 fields
  uint8_t m_format;       
  uint8_t m_bssColor;     
  uint8_t m_ul_dl;        
  uint8_t m_mcs;          
  uint8_t m_spatialReuse; 
  uint8_t m_bandwidth;    
  uint8_t m_gi_ltf_size;  
  uint8_t m_nsts;         

  //HE-SIG-A2 fields
  uint8_t m_coding; 

  bool m_mu;
};

} //namespace ns3

#endif /* WIFI_PHY_HEADER_H */