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

/*

 * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)

 *

 * 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: Lluis Parcerisa <lparcerisa@cttc.cat>

 */

#ifndef RRC_HEADER_H

#define RRC_HEADER_H

#include "ns3/header.h"

#include <bitset>

#include <string>

#include "ns3/lte-rrc-sap.h"

#include "ns3/lte-asn1-header.h"

namespace ns3 {

/**

 * This class extends Asn1Header functions, adding serialization/deserialization

 * of some Information elements defined in 3GPP TS 36.331

 */

class RrcAsn1Header : public Asn1Header

{

public:

  RrcAsn1Header ();

  int GetMessageType ();

protected:

  // Inherited from Asn1Header

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  uint32_t Deserialize (Buffer::Iterator bIterator) = 0;

  virtual void PreSerialize (void) const = 0;

  // Serialization functions

  void SerializeSrbToAddModList (std::list<LteRrcSap::SrbToAddMod> srbToAddModList) const;

  void SerializeDrbToAddModList (std::list<LteRrcSap::DrbToAddMod> drbToAddModList) const;

  void SerializeLogicalChannelConfig (LteRrcSap::LogicalChannelConfig logicalChannelConfig) const;

  void SerializeRadioResourceConfigDedicated (LteRrcSap::RadioResourceConfigDedicated radioResourceConfigDedicated) const;

  void SerializePhysicalConfigDedicated (LteRrcSap::PhysicalConfigDedicated physicalConfigDedicated) const;

  void SerializeSystemInformationBlockType1 (LteRrcSap::SystemInformationBlockType1 systemInformationBlockType1) const;

  void SerializeSystemInformationBlockType2 (LteRrcSap::SystemInformationBlockType2 systemInformationBlockType2) const;

  void SerializeRadioResourceConfigCommon (LteRrcSap::RadioResourceConfigCommon radioResourceConfigCommon) const;

  void SerializeRadioResourceConfigCommonSib (LteRrcSap::RadioResourceConfigCommonSib radioResourceConfigCommonSib) const;

  void SerializeMeasResults (LteRrcSap::MeasResults measResults) const;

  void SerializePlmnIdentity (uint32_t plmnId) const;

  void SerializeRachConfigCommon (LteRrcSap::RachConfigCommon rachConfigCommon) const;

  // Deserialization functions

  Buffer::Iterator DeserializeDrbToAddModList (std::list<LteRrcSap::DrbToAddMod> *drbToAddModLis, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeSrbToAddModList (std::list<LteRrcSap::SrbToAddMod> *srbToAddModList, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeLogicalChannelConfig (LteRrcSap::LogicalChannelConfig *logicalChannelConfig, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeRadioResourceConfigDedicated (LteRrcSap::RadioResourceConfigDedicated *radioResourceConfigDedicated, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializePhysicalConfigDedicated (LteRrcSap::PhysicalConfigDedicated *physicalConfigDedicated, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeSystemInformationBlockType1 (LteRrcSap::SystemInformationBlockType1 *systemInformationBlockType1, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeSystemInformationBlockType2 (LteRrcSap::SystemInformationBlockType2 *systemInformationBlockType2, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeRadioResourceConfigCommon (LteRrcSap::RadioResourceConfigCommon *radioResourceConfigCommon, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeRadioResourceConfigCommonSib (LteRrcSap::RadioResourceConfigCommonSib *radioResourceConfigCommonSib, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeMeasResults (LteRrcSap::MeasResults *measResults, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializePlmnIdentity (uint32_t *plmnId, Buffer::Iterator bIterator);

  Buffer::Iterator DeserializeRachConfigCommon (LteRrcSap::RachConfigCommon * rachConfigCommon, Buffer::Iterator bIterator);

  /**

   * This function prints RadioResourceConfigDedicated IE, for debugging purposes.

   * @param os The output stream to use (i.e. std::cout)

   * @param radioResourceConfigDedicated The information element to be printed

   */

  void Print (std::ostream &os, LteRrcSap::RadioResourceConfigDedicated radioResourceConfigDedicated) const;

  /// Stores RRC message type, according to 3GPP TS 36.331

  int m_messageType;

};

/**

 * This class only serves to discriminate which message type has been received

 * in uplink (ue to eNb) for channel DCCH

 */

class RrcUlDcchMessage : public RrcAsn1Header

{

public:

  RrcUlDcchMessage ();

  ~RrcUlDcchMessage ();

  // Inherited from RrcAsn1Header

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  void PreSerialize () const;

protected:

  void SerializeUlDcchMessage (int msgType) const;

  Buffer::Iterator DeserializeUlDcchMessage (Buffer::Iterator bIterator);

};

/**

 * This class only serves to discriminate which message type has been received

 * in downlink (eNb to ue) for channel DCCH

 */

class RrcDlDcchMessage : public RrcAsn1Header

{

public:

  RrcDlDcchMessage ();

  ~RrcDlDcchMessage ();

  // Inherited from RrcAsn1Header

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  void PreSerialize () const;

protected:

  void SerializeDlDcchMessage (int msgType) const;

  Buffer::Iterator DeserializeDlDcchMessage (Buffer::Iterator bIterator);

};

/**

 * This class only serves to discriminate which message type has been received

 * in uplink (ue to eNb) for channel CCCH

 */

class RrcUlCcchMessage : public RrcAsn1Header

{

public:

  RrcUlCcchMessage ();

  ~RrcUlCcchMessage ();

  // Inherited from RrcAsn1Header 

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  void PreSerialize () const;

protected:

  void SerializeUlCcchMessage (int msgType) const;

  Buffer::Iterator DeserializeUlCcchMessage (Buffer::Iterator bIterator);

};

/**

 * This class only serves to discriminate which message type has been received

 * in downlink (eNb to ue) for channel CCCH

 */

class RrcDlCcchMessage : public RrcAsn1Header

{

public:

  RrcDlCcchMessage ();

  ~RrcDlCcchMessage ();

  // Inherited from RrcAsn1Header 

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  void PreSerialize () const;

protected:

  void SerializeDlCcchMessage (int msgType) const;

  Buffer::Iterator DeserializeDlCcchMessage (Buffer::Iterator bIterator);

};

/**

* This class manages the serialization/deserialization of RrcConnectionRequest IE

*/

class RrcConnectionRequestHeader : public RrcUlCcchMessage

{

public:

  RrcConnectionRequestHeader ();

  ~RrcConnectionRequestHeader ();

  // Inherited from RrcAsn1Header 

  static TypeId GetTypeId (void);

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

   * Receives a RrcConnectionRequest IE and stores the contents into the class attributes

   * @param msg The information element to parse

   */

  void SetMessage (LteRrcSap::RrcConnectionRequest msg);

  /**

   * Returns a RrcConnectionRequest IE from the values in the class attributes

   * @return A RrcConnectionRequest, as defined in LteRrcSap

   */

  LteRrcSap::RrcConnectionRequest GetMessage () const;

  /**

   * Get MMEC attribute

   * @return m_mmec attribute

   */

  std::bitset<8> GetMmec () const;

  /**

   * Get M-TMSI attribute

   * @return m_tmsi attribute

   */

  std::bitset<32> GetMtmsi () const;

private:

  std::bitset<8> m_mmec;

  std::bitset<32> m_mTmsi;

  enum

  {

    EMERGENCY = 0, HIGHPRIORITYACCESS, MT_ACCESS,

    MO_SIGNALLING, MO_DATA, SPARE3, SPARE2, SPARE1

  } m_establishmentCause;

  std::bitset<1> m_spare;

};

/**

* This class manages the serialization/deserialization of RrcConnectionSetup IE

*/

class RrcConnectionSetupHeader : public RrcDlCcchMessage

{

public:

  RrcConnectionSetupHeader ();

  ~RrcConnectionSetupHeader ();

  // Inherited from RrcAsn1Header 

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

  * Receives a RrcConnectionSetup IE and stores the contents into the class attributes

  * @param msg The information element to parse

  */

  void SetMessage (LteRrcSap::RrcConnectionSetup msg);

  /**

  * Returns a RrcConnectionSetup IE from the values in the class attributes

  * @return A RrcConnectionSetup, as defined in LteRrcSap

  */

  LteRrcSap::RrcConnectionSetup GetMessage () const;

  /**

  * Getter for m_rrcTransactionIdentifier

  * @return m_rrcTransactionIdentifier

  */

  uint8_t GetRrcTransactionIdentifier () const;

  /**

  * Getter for m_radioResourceConfigDedicated

  * @return m_radioResourceConfigDedicated

  */

  LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated () const; 

  /**

  * Gets m_radioResourceConfigDedicated.havePhysicalConfigDedicated

  * @return m_radioResourceConfigDedicated.havePhysicalConfigDedicated

  */

  bool HavePhysicalConfigDedicated () const;

  /**

  * Gets m_radioResourceConfigDedicated.physicalConfigDedicated

  * @return m_radioResourceConfigDedicated.physicalConfigDedicated

  */

  LteRrcSap::PhysicalConfigDedicated GetPhysicalConfigDedicated () const;

  /**

  * Gets m_radioResourceConfigDedicated.srbToAddModList

  * @return m_radioResourceConfigDedicated.srbToAddModList

  */

  std::list<LteRrcSap::SrbToAddMod> GetSrbToAddModList () const;

  /**

  * Gets m_radioResourceConfigDedicated.drbToAddModList

  * @return m_radioResourceConfigDedicated.drbToAddModList

  */

  std::list<LteRrcSap::DrbToAddMod> GetDrbToAddModList () const;

  /**

  * Gets m_radioResourceConfigDedicated.drbToReleaseList

  * @return m_radioResourceConfigDedicated.drbToReleaseList

  */

  std::list<uint8_t> GetDrbToReleaseList () const;

private:

  uint8_t m_rrcTransactionIdentifier;

  mutable LteRrcSap::RadioResourceConfigDedicated m_radioResourceConfigDedicated;

};

/**

* This class manages the serialization/deserialization of RrcConnectionSetupComplete IE

*/

class RrcConnectionSetupCompleteHeader : public RrcUlDcchMessage

{

public:

  RrcConnectionSetupCompleteHeader ();

  ~RrcConnectionSetupCompleteHeader ();

  // Inherited from RrcAsn1Header 

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

  * Receives a RrcConnectionSetupCompleted IE and stores the contents into the class attributes

  * @param msg The information element to parse

  */

  void SetMessage (LteRrcSap::RrcConnectionSetupCompleted msg);

  /**

  * Returns a RrcConnectionSetupCompleted IE from the values in the class attributes

  * @return A RrcConnectionSetupCompleted, as defined in LteRrcSap

  */

  LteRrcSap::RrcConnectionSetupCompleted GetMessage () const;

  /**

  * Getter for m_rrcTransactionIdentifier

  * @return m_rrcTransactionIdentifier

  */

  uint8_t GetRrcTransactionIdentifier () const;

private:

  uint8_t m_rrcTransactionIdentifier;

};

/**

* This class manages the serialization/deserialization of RrcConnectionSetupComplete IE

*/

class RrcConnectionReconfigurationCompleteHeader : public RrcUlDcchMessage

{

public:

  RrcConnectionReconfigurationCompleteHeader ();

  ~RrcConnectionReconfigurationCompleteHeader ();

  // Inherited from RrcAsn1Header 

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

  * Receives a RrcConnectionReconfigurationCompleted IE and stores the contents into the class attributes

  * @param msg The information element to parse

  */

  void SetMessage (LteRrcSap::RrcConnectionReconfigurationCompleted msg);

  /**

  * Returns a RrcConnectionReconfigurationCompleted IE from the values in the class attributes

  * @return A RrcConnectionReconfigurationCompleted, as defined in LteRrcSap

  */

  LteRrcSap::RrcConnectionReconfigurationCompleted GetMessage () const;

  /**

  * Getter for m_rrcTransactionIdentifier

  * @return m_rrcTransactionIdentifier

  */ 

  uint8_t GetRrcTransactionIdentifier () const;

private:

  uint8_t m_rrcTransactionIdentifier;

};

/**

* This class manages the serialization/deserialization of RrcConnectionReconfiguration IE

*/

class RrcConnectionReconfigurationHeader : public RrcDlDcchMessage

{

public:

  RrcConnectionReconfigurationHeader ();

  ~RrcConnectionReconfigurationHeader ();

  // Inherited from RrcAsn1Header 

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

  * Receives a RrcConnectionReconfiguration IE and stores the contents into the class attributes

  * @param msg The information element to parse

  */ 

  void SetMessage (LteRrcSap::RrcConnectionReconfiguration msg);

  /**

  * Returns a RrcConnectionReconfiguration IE from the values in the class attributes

  * @return A RrcConnectionReconfiguration, as defined in LteRrcSap

  */

  LteRrcSap::RrcConnectionReconfiguration GetMessage () const; 

  /**

  * Getter for m_haveMeasConfig

  * @return m_haveMeasConfig

  */

  bool GetHaveMeasConfig ();

  /**

  * Getter for m_measConfig

  * @return m_measConfig

  */

  LteRrcSap::MeasConfig GetMeasConfig ();

  /**

  * Getter for m_haveMobilityControlInfo

  * @return m_haveMobilityControlInfo

  */

  bool GetHaveMobilityControlInfo ();

  /**

  * Getter for m_mobilityControlInfo

  * @return m_mobilityControlInfo

  */

  LteRrcSap::MobilityControlInfo GetMobilityControlInfo ();

  /**

  * Getter for m_haveRadioResourceConfigDedicated

  * @return m_haveRadioResourceConfigDedicated

  */

  bool GetHaveRadioResourceConfigDedicated ();

  /**

  * Getter for m_radioResourceConfigDedicated

  * @return m_radioResourceConfigDedicated

  */

  LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated ();

  /**

  * Getter for m_rrcTransactionIdentifier

  * @return m_rrcTransactionIdentifier

  */

  uint8_t GetRrcTransactionIdentifier () const;

  /**

  * Getter for m_radioResourceConfigDedicated

  * @return m_radioResourceConfigDedicated

  */

  LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigDedicated () const; 

  /**

  * Gets m_radioResourceConfigDedicated.havePhysicalConfigDedicated

  * @return m_radioResourceConfigDedicated.havePhysicalConfigDedicated

  */

  bool HavePhysicalConfigDedicated () const;

  /**

  * Gets m_radioResourceConfigDedicated.physicalConfigDedicated

  * @return m_radioResourceConfigDedicated.physicalConfigDedicated

  */

  LteRrcSap::PhysicalConfigDedicated GetPhysicalConfigDedicated () const;

  /**

  * Gets m_radioResourceConfigDedicated.srbToAddModList

  * @return m_radioResourceConfigDedicated.srbToAddModList

  */

  std::list<LteRrcSap::SrbToAddMod> GetSrbToAddModList () const;

  /**

  * Gets m_radioResourceConfigDedicated.drbToAddModList

  * @return m_radioResourceConfigDedicated.drbToAddModList

  */

  std::list<LteRrcSap::DrbToAddMod> GetDrbToAddModList () const;

  /**

  * Gets m_radioResourceConfigDedicated.drbToReleaseList

  * @return m_radioResourceConfigDedicated.drbToReleaseList

  */

  std::list<uint8_t> GetDrbToReleaseList () const;

private:

  uint8_t m_rrcTransactionIdentifier;

  bool m_haveMeasConfig;

  LteRrcSap::MeasConfig m_measConfig;

  bool m_haveMobilityControlInfo;

  LteRrcSap::MobilityControlInfo m_mobilityControlInfo;

  bool m_haveRadioResourceConfigDedicated;

  LteRrcSap::RadioResourceConfigDedicated m_radioResourceConfigDedicated;

};

/**

* This class manages the serialization/deserialization of HandoverPreparationInfo IE

*/

class HandoverPreparationInfoHeader : public RrcAsn1Header

{

public:

  HandoverPreparationInfoHeader ();

  // Inherited from RrcAsn1Header 

  void PreSerialize () const;

  uint32_t Deserialize (Buffer::Iterator bIterator);

  void Print (std::ostream &os) const;

  /**

  * Receives a HandoverPreparationInfo IE and stores the contents into the class attributes

  * @param msg The information element to parse