lr-wpan-phy.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 The Boeing Company
 *
 * 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:
 *  Gary Pei <guangyu.pei@boeing.com>
 *  Sascha Alexander Jopen <jopen@cs.uni-bonn.de>
 */
#ifndef LR_WPAN_PHY_H
#define LR_WPAN_PHY_H

#include "lr-wpan-interference-helper.h"

#include <ns3/spectrum-phy.h>
#include <ns3/traced-callback.h>
#include <ns3/traced-value.h>
#include <ns3/event-id.h>

namespace ns3 {

class Packet;
class SpectrumValue;
class LrWpanErrorModel;
struct LrWpanSpectrumSignalParameters;
class MobilityModel;
class SpectrumChannel;
class SpectrumModel;
class AntennaModel;
class NetDevice;
class UniformRandomVariable;

typedef struct
{
  double averagePower;    
  Time lastUpdate;        
  Time measurementLength; 
} LrWpanEdPower;

typedef  struct
{
  double bitRate;    
  double symbolRate; 
} LrWpanPhyDataAndSymbolRates;

typedef  struct
{
  double shrPreamble; 
  double shrSfd;      
  double phr;         
} LrWpanPhyPpduHeaderSymbolNumber;

typedef enum
{
  IEEE_802_15_4_868MHZ_BPSK         = 0,
  IEEE_802_15_4_915MHZ_BPSK         = 1,
  IEEE_802_15_4_868MHZ_ASK          = 2,
  IEEE_802_15_4_915MHZ_ASK          = 3,
  IEEE_802_15_4_868MHZ_OQPSK        = 4,
  IEEE_802_15_4_915MHZ_OQPSK        = 5,
  IEEE_802_15_4_2_4GHZ_OQPSK        = 6,
  IEEE_802_15_4_INVALID_PHY_OPTION  = 7
} LrWpanPhyOption;

typedef enum
{
  IEEE_802_15_4_PHY_BUSY  = 0x00,
  IEEE_802_15_4_PHY_BUSY_RX = 0x01,
  IEEE_802_15_4_PHY_BUSY_TX = 0x02,
  IEEE_802_15_4_PHY_FORCE_TRX_OFF = 0x03,
  IEEE_802_15_4_PHY_IDLE = 0x04,
  IEEE_802_15_4_PHY_INVALID_PARAMETER = 0x05,
  IEEE_802_15_4_PHY_RX_ON = 0x06,
  IEEE_802_15_4_PHY_SUCCESS = 0x07,
  IEEE_802_15_4_PHY_TRX_OFF = 0x08,
  IEEE_802_15_4_PHY_TX_ON = 0x09,
  IEEE_802_15_4_PHY_UNSUPPORTED_ATTRIBUTE = 0xa,
  IEEE_802_15_4_PHY_READ_ONLY = 0xb,
  IEEE_802_15_4_PHY_UNSPECIFIED = 0xc // all cases not covered by ieee802.15.4
} LrWpanPhyEnumeration;

namespace TracedValueCallback
{
  typedef void (* LrWpanPhyEnumeration)(LrWpanPhyEnumeration oldValue,
                                        LrWpanPhyEnumeration newValue);
}  // namespace TracedValueCallback

typedef enum
{
  phyCurrentChannel = 0x00,
  phyChannelsSupported = 0x01,
  phyTransmitPower = 0x02,
  phyCCAMode = 0x03,
  phyCurrentPage = 0x04,
  phyMaxFrameDuration = 0x05,
  phySHRDuration = 0x06,
  phySymbolsPerOctet = 0x07
} LrWpanPibAttributeIdentifier;

typedef struct
{
  uint8_t phyCurrentChannel;         
  uint32_t phyChannelsSupported[32]; 
  uint8_t phyTransmitPower;          
  uint8_t phyCCAMode;                
  uint32_t phyCurrentPage;           
  uint32_t phyMaxFrameDuration;      
  uint32_t phySHRDuration;           
  double phySymbolsPerOctet;         
} LrWpanPhyPibAttributes;

typedef Callback< void, uint32_t, Ptr<Packet>, uint8_t > PdDataIndicationCallback;

typedef Callback< void, LrWpanPhyEnumeration > PdDataConfirmCallback;

typedef Callback< void, LrWpanPhyEnumeration > PlmeCcaConfirmCallback;

typedef Callback< void, LrWpanPhyEnumeration,uint8_t > PlmeEdConfirmCallback;

typedef Callback< void, LrWpanPhyEnumeration,
                  LrWpanPibAttributeIdentifier,
                  LrWpanPhyPibAttributes* > PlmeGetAttributeConfirmCallback;

typedef Callback< void, LrWpanPhyEnumeration > PlmeSetTRXStateConfirmCallback;

typedef Callback< void, LrWpanPhyEnumeration,
                  LrWpanPibAttributeIdentifier > PlmeSetAttributeConfirmCallback;

class LrWpanPhy : public SpectrumPhy
{

public:
  static TypeId GetTypeId (void);

  static const uint32_t aMaxPhyPacketSize;

  static const uint32_t aTurnaroundTime;

  LrWpanPhy (void);
  virtual ~LrWpanPhy (void);

  // inherited from SpectrumPhy
  void SetMobility (Ptr<MobilityModel> m);
  Ptr<MobilityModel> GetMobility (void);
  void SetChannel (Ptr<SpectrumChannel> c);

  Ptr<SpectrumChannel> GetChannel (void);
  void SetDevice (Ptr<NetDevice> d);
  Ptr<NetDevice> GetDevice (void) const;

  void SetAntenna (Ptr<AntennaModel> a);
  Ptr<AntennaModel> GetRxAntenna (void);
  virtual Ptr<const SpectrumModel> GetRxSpectrumModel (void) const;

  void SetTxPowerSpectralDensity (Ptr<SpectrumValue> txPsd);

  void SetNoisePowerSpectralDensity (Ptr<const SpectrumValue> noisePsd);

  Ptr<const SpectrumValue> GetNoisePowerSpectralDensity (void);

  virtual void StartRx (Ptr<SpectrumSignalParameters> params);

  void PdDataRequest (const uint32_t psduLength, Ptr<Packet> p);

  void PlmeCcaRequest (void);

  void PlmeEdRequest (void);

  void PlmeGetAttributeRequest (LrWpanPibAttributeIdentifier id);

  void PlmeSetTRXStateRequest (LrWpanPhyEnumeration state);

  void PlmeSetAttributeRequest (LrWpanPibAttributeIdentifier id, LrWpanPhyPibAttributes* attribute);

  void SetPdDataIndicationCallback (PdDataIndicationCallback c);

  void SetPdDataConfirmCallback (PdDataConfirmCallback c);

  void SetPlmeCcaConfirmCallback (PlmeCcaConfirmCallback c);

  void SetPlmeEdConfirmCallback (PlmeEdConfirmCallback c);

  void SetPlmeGetAttributeConfirmCallback (PlmeGetAttributeConfirmCallback c);

  void SetPlmeSetTRXStateConfirmCallback (PlmeSetTRXStateConfirmCallback c);

  void SetPlmeSetAttributeConfirmCallback (PlmeSetAttributeConfirmCallback c);

  double GetDataOrSymbolRate (bool isData);

  void SetErrorModel (Ptr<LrWpanErrorModel> e);

  Ptr<LrWpanErrorModel> GetErrorModel (void) const;

  uint64_t GetPhySHRDuration (void) const;

  double GetPhySymbolsPerOctet (void) const;

  int64_t AssignStreams (int64_t stream);

  typedef void (* StateTracedCallback)
    (Time time, LrWpanPhyEnumeration oldState, LrWpanPhyEnumeration newState);

protected:
  static const LrWpanPhyDataAndSymbolRates dataSymbolRates[7];
  static const LrWpanPhyPpduHeaderSymbolNumber ppduHeaderSymbolNumbers[7];

private:
  typedef std::pair<Ptr<Packet>, bool>  PacketAndStatus;

  // Inherited from Object.
  virtual void DoDispose (void);

  void ChangeTrxState (LrWpanPhyEnumeration newState);

  void SetMyPhyOption (void);

  LrWpanPhyOption GetMyPhyOption (void);

  void EndTx (void);

  void CheckInterference (void);

  void EndRx (Ptr<SpectrumSignalParameters> params);

  void CancelEd (LrWpanPhyEnumeration state);

  void EndEd (void);

  void EndCca (void);

  void EndSetTRXState (void);

  Time CalculateTxTime (Ptr<const Packet> packet);

  Time GetPpduHeaderTxTime (void);

  bool ChannelSupported (uint8_t channel);

  bool PhyIsBusy (void) const;

  // Trace sources
  TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;

  TracedCallback<Ptr<const Packet>, double > m_phyRxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;

  TracedCallback<Time, LrWpanPhyEnumeration, LrWpanPhyEnumeration> m_trxStateLogger;

  Ptr<MobilityModel> m_mobility;

  Ptr<NetDevice> m_device;

  Ptr<SpectrumChannel> m_channel;

  Ptr<AntennaModel> m_antenna;

  Ptr<SpectrumValue> m_txPsd;

  Ptr<const SpectrumValue> m_noise;

  Ptr<LrWpanErrorModel> m_errorModel;

  LrWpanPhyPibAttributes m_phyPIBAttributes;

  // State variables
  TracedValue<LrWpanPhyEnumeration> m_trxState;

  LrWpanPhyEnumeration m_trxStatePending;

  // Callbacks
  PdDataIndicationCallback m_pdDataIndicationCallback;

  PdDataConfirmCallback m_pdDataConfirmCallback;

  PlmeCcaConfirmCallback m_plmeCcaConfirmCallback;

  PlmeEdConfirmCallback m_plmeEdConfirmCallback;

  PlmeGetAttributeConfirmCallback m_plmeGetAttributeConfirmCallback;

  PlmeSetTRXStateConfirmCallback m_plmeSetTRXStateConfirmCallback;

  PlmeSetAttributeConfirmCallback m_plmeSetAttributeConfirmCallback;

  LrWpanPhyOption m_phyOption;

  LrWpanEdPower m_edPower;

  double m_ccaPeakPower;

  double m_rxSensitivity;

  Ptr<LrWpanInterferenceHelper> m_signal;

  Time m_rxLastUpdate;

  std::pair<Ptr<LrWpanSpectrumSignalParameters>, bool>  m_currentRxPacket;

  PacketAndStatus m_currentTxPacket;

  EventId m_ccaRequest;

  EventId m_edRequest;

  EventId m_setTRXState;

  EventId m_pdDataRequest;

  Ptr<UniformRandomVariable> m_random;
};


} // namespace ns3

#endif /* LR_WPAN_PHY_H */