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

 *

 * Authors: Nicola Baldo <nbaldo@cttc.es>

 *          Lluis Parcerisa <lparcerisa@cttc.cat>

 */

#ifndef LTE_RRC_SAP_H

#define LTE_RRC_SAP_H

#include <stdint.h>

#include <list>

#include <ns3/ptr.h>

#include <ns3/simulator.h>

namespace ns3 {

class LteRlcSapUser;

class LtePdcpSapUser;

class LteRlcSapProvider;

class LtePdcpSapProvider;

class Packet;

/**

 * \ingroup lte

 *

 * \brief Class holding definition common to all UE/eNodeB SAP Users/Providers.

 *

 * See 3GPP TS 36.331 for reference.

 *

 * Note that only those values that are (expected to be) used by the

 * ns-3 model are mentioned here. The naming of the variables that are

 * defined here is the same of 36.331, except for removal of "-" and

 * conversion to CamelCase or ALL_CAPS where needed in order to follow

 * the ns-3 coding style. Due to the 1-to-1 mapping with TS 36.331,

 * detailed doxygen documentation is omitted, so please refer to

 * 36.331 for the meaning of these data structures / fields.

 *

 */

class LteRrcSap

{

public:

  virtual ~LteRrcSap ();

  // Constraint values

  static const uint8_t MaxReportCells = 255;

  // Information Elements

  struct PlmnIdentityInfo

  {

    uint32_t plmnIdentity;

  };

  struct CellAccessRelatedInfo

  {

    PlmnIdentityInfo plmnIdentityInfo;

    uint32_t cellIdentity;

    bool csgIndication;

    uint32_t csgIdentity;

  };

  struct CellSelectionInfo

  {

    int8_t qRxLevMin; ///< INTEGER (-70..-22), actual value = IE value * 2 [dBm].

    int8_t qQualMin; ///< INTEGER (-34..-3), actual value = IE value [dB].

  };

  struct FreqInfo

  {

    uint16_t ulCarrierFreq;

    uint8_t ulBandwidth;

  };

  struct RlcConfig

  {

    enum

    {

      AM,

      UM_BI_DIRECTIONAL,

      UM_UNI_DIRECTIONAL_UL,

      UM_UNI_DIRECTIONAL_DL

    } choice;

  };

  struct LogicalChannelConfig

  {

    uint8_t priority;

    uint16_t prioritizedBitRateKbps;

    uint16_t bucketSizeDurationMs;

    uint8_t logicalChannelGroup;

  };

  struct SoundingRsUlConfigCommon

  {

    enum

    {

      SETUP, RESET

    } type;

    uint8_t srsBandwidthConfig;

    uint8_t srsSubframeConfig;

  };

  struct SoundingRsUlConfigDedicated

  {

    enum

    {

      SETUP, RESET

    } type;

    uint8_t srsBandwidth;

    uint16_t srsConfigIndex;

  };

  struct AntennaInfoDedicated

  {

    uint8_t transmissionMode;

  };

  struct PdschConfigCommon

  {

	int8_t referenceSignalPower;  // INTEGER (-60..50),

    int8_t pb;                    // INTEGER (0..3),

  };

  struct PdschConfigDedicated

  {

    /*

     * P_A values, TS 36.331 6.3.2 PDSCH-Config

     * ENUMERATED { dB-6, dB-4dot77, dB-3, dB-1dot77, dB0, dB1, dB2, dB3 }

     */

    enum

    {

      dB_6,

      dB_4dot77,

      dB_3,

      dB_1dot77,

      dB0,

      dB1,

      dB2,

      dB3

    };

    uint8_t pa;

  };

  static double ConvertPdschConfigDedicated2Double (PdschConfigDedicated pdschConfigDedicated)

  {

    double pa = 0;

    switch (pdschConfigDedicated.pa)

      {

      case PdschConfigDedicated::dB_6:

        pa = -6;

        break;

      case PdschConfigDedicated::dB_4dot77:

        pa = -4.77;

        break;

      case PdschConfigDedicated::dB_3:

        pa = -3;

        break;

      case PdschConfigDedicated::dB_1dot77:

        pa = -1.77;

        break;

      case PdschConfigDedicated::dB0:

        pa = 0;

        break;

      case PdschConfigDedicated::dB1:

        pa = 1;

        break;

      case PdschConfigDedicated::dB2:

        pa = 2;

        break;

      case PdschConfigDedicated::dB3:

        pa = 3;

        break;

      default:

        break;

      }

    return pa;

  }

  struct PhysicalConfigDedicated

  {

    bool haveSoundingRsUlConfigDedicated;

    SoundingRsUlConfigDedicated soundingRsUlConfigDedicated;

    bool haveAntennaInfoDedicated;

    AntennaInfoDedicated antennaInfo;

    bool havePdschConfigDedicated;

    PdschConfigDedicated pdschConfigDedicated;

  };

  struct SrbToAddMod

  {

    uint8_t srbIdentity;

    LogicalChannelConfig logicalChannelConfig;

  };

  struct DrbToAddMod

  {

    uint8_t epsBearerIdentity;

    uint8_t drbIdentity;

    RlcConfig rlcConfig;

    uint8_t logicalChannelIdentity;

    LogicalChannelConfig logicalChannelConfig;

  };

  struct PreambleInfo

  {

    uint8_t numberOfRaPreambles;

  };

  struct RaSupervisionInfo

  {

    uint8_t preambleTransMax;

    uint8_t raResponseWindowSize;

  };

  struct RachConfigCommon

  {

    PreambleInfo preambleInfo;

    RaSupervisionInfo raSupervisionInfo;

  };

  struct RadioResourceConfigCommon

  {

    RachConfigCommon rachConfigCommon;

  };

  struct RadioResourceConfigCommonSib

  {

    RachConfigCommon rachConfigCommon;

    PdschConfigCommon pdschConfigCommon;

  };

  struct RadioResourceConfigDedicated

  {

    std::list<SrbToAddMod> srbToAddModList;

    std::list<DrbToAddMod> drbToAddModList;

    std::list<uint8_t> drbToReleaseList;

    bool havePhysicalConfigDedicated;

    PhysicalConfigDedicated physicalConfigDedicated;

  };

  struct QuantityConfig

  {

    uint8_t filterCoefficientRSRP;

    uint8_t filterCoefficientRSRQ;

  };

  struct CellsToAddMod

  {

    uint8_t cellIndex;

    uint16_t physCellId;

    int8_t cellIndividualOffset;

  };

  struct PhysCellIdRange

  {

    uint16_t start;

    bool haveRange;

    uint16_t range;

  };

  struct BlackCellsToAddMod

  {

    uint8_t cellIndex;

    PhysCellIdRange physCellIdRange;

  };

  struct MeasObjectEutra

  {

    uint16_t carrierFreq;

    uint8_t allowedMeasBandwidth;

    bool presenceAntennaPort1;

    uint8_t neighCellConfig;

    int8_t offsetFreq;

    std::list<uint8_t> cellsToRemoveList;

    std::list<CellsToAddMod> cellsToAddModList;

    std::list<uint8_t> blackCellsToRemoveList;

    std::list<BlackCellsToAddMod> blackCellsToAddModList;

    bool haveCellForWhichToReportCGI;

    uint8_t cellForWhichToReportCGI;

  };

  /**

   * \brief Threshold for event evaluation.

   *

   * For RSRP-based threshold, the actual value is (value - 140) dBm. While for

   * RSRQ-based threshold, the actual value is (value - 40) / 2 dB. This is in

   * accordance with section 9.1.4 and 9.1.7 of 3GPP TS 36.133.

   *

   * \sa ns3::EutranMeasurementMapping

   */

  struct ThresholdEutra

  {

    enum

    {

      THRESHOLD_RSRP, ///< RSRP is used for the threshold.

      THRESHOLD_RSRQ ///< RSRQ is used for the threshold.

    } choice;

    uint8_t range; ///< Value range used in RSRP/RSRQ threshold.

  };

  /// Specifies criteria for triggering of an E-UTRA measurement reporting event.

  struct ReportConfigEutra

  {

    enum

    {

      EVENT,

      PERIODICAL

    } triggerType;

    enum

    {

      EVENT_A1, ///< Event A1: Serving becomes better than absolute threshold.

      EVENT_A2, ///< Event A2: Serving becomes worse than absolute threshold.

      EVENT_A3, ///< Event A3: Neighbour becomes amount of offset better than PCell.

      EVENT_A4, ///< Event A4: Neighbour becomes better than absolute threshold.

      EVENT_A5 ///< Event A5: PCell becomes worse than absolute `threshold1` AND Neighbour becomes better than another absolute `threshold2`.

    } eventId; ///< Choice of E-UTRA event triggered reporting criteria.

    ThresholdEutra threshold1; ///< Threshold for event A1, A2, A4, and A5.

    ThresholdEutra threshold2; ///< Threshold for event A5.

    /// Indicates whether or not the UE shall initiate the measurement reporting procedure when the leaving condition is met for a cell in `cellsTriggeredList`, as specified in 5.5.4.1 of 3GPP TS 36.331.

    bool reportOnLeave;

    /// Offset value for Event A3. An integer between -30 and 30. The actual value is (value * 0.5) dB.

    int8_t a3Offset;

    /// Parameter used within the entry and leave condition of an event triggered reporting condition. The actual value is (value * 0.5) dB.

    uint8_t hysteresis;

    /// Time during which specific criteria for the event needs to be met in order to trigger a measurement report.

    uint16_t timeToTrigger;

    enum

    {

      REPORT_STRONGEST_CELLS,

      REPORT_CGI

    } purpose;

    enum

    {

      RSRP, ///< Reference Signal Received Power

      RSRQ ///< Reference Signal Received Quality

    } triggerQuantity; ///< The quantities used to evaluate the triggering condition for the event, see 3GPP TS 36.214.

    enum

    {

      SAME_AS_TRIGGER_QUANTITY,

      BOTH ///< Both the RSRP and RSRQ quantities are to be included in the measurement report.

    } reportQuantity; ///< The quantities to be included in the measurement report, always assumed to be BOTH.

    /// Maximum number of cells, excluding the serving cell, to be included in the measurement report.

    uint8_t maxReportCells;

    enum

    {

      MS120,

      MS240,

      MS480,

      MS640,

      MS1024,

      MS2048,

      MS5120,

      MS10240,

      MIN1,

      MIN6,

      MIN12,

      MIN30,

      MIN60,

      SPARE3,

      SPARE2,

      SPARE1

    } reportInterval; ///< Indicates the interval between periodical reports.

    /// Number of measurement reports applicable, always assumed to be infinite.

    uint8_t reportAmount;

    ReportConfigEutra ();

  }; // end of struct ReportConfigEutra

  struct MeasObjectToAddMod

  {

    uint8_t measObjectId;

    MeasObjectEutra measObjectEutra;

  };

  struct ReportConfigToAddMod

  {

    uint8_t reportConfigId;

    ReportConfigEutra reportConfigEutra;

  };

  struct MeasIdToAddMod

  {

    uint8_t measId;

    uint8_t measObjectId;

    uint8_t reportConfigId;

  };

  struct MeasGapConfig

  {

    enum

    {

      SETUP, RESET

    } type;

    enum

    {

      GP0, GP1

    } gapOffsetChoice;

    uint8_t gapOffsetValue;

  };

  struct MobilityStateParameters

  {

    uint8_t tEvaluation;

    uint8_t tHystNormal;

    uint8_t nCellChangeMedium;

    uint8_t nCellChangeHigh;

  };

  struct SpeedStateScaleFactors

  {

    // 25 = oDot25, 50 = oDot5, 75 = oDot75, 100 = lDot0

    uint8_t sfMedium;

    uint8_t sfHigh;

  };

  struct SpeedStatePars

  {

    enum

    {

      SETUP,

      RESET

    } type;

    MobilityStateParameters mobilityStateParameters;

    SpeedStateScaleFactors timeToTriggerSf;

  };

  struct MeasConfig

  {

    std::list<uint8_t> measObjectToRemoveList;

    std::list<MeasObjectToAddMod> measObjectToAddModList;

    std::list<uint8_t> reportConfigToRemoveList;

    std::list<ReportConfigToAddMod> reportConfigToAddModList;

    std::list<uint8_t> measIdToRemoveList;

    std::list<MeasIdToAddMod> measIdToAddModList;

    bool haveQuantityConfig;

    QuantityConfig quantityConfig;

    bool haveMeasGapConfig;

    MeasGapConfig measGapConfig;

    bool haveSmeasure;

    uint8_t sMeasure;

    bool haveSpeedStatePars;

    SpeedStatePars speedStatePars;

  };

  struct CarrierFreqEutra

  {

    uint16_t dlCarrierFreq;

    uint16_t ulCarrierFreq;

  };

  struct CarrierBandwidthEutra

  {

    uint8_t dlBandwidth;

    uint8_t ulBandwidth;

  };

  struct RachConfigDedicated

  {

    uint8_t raPreambleIndex;

    uint8_t raPrachMaskIndex;

  };

  struct MobilityControlInfo

  {

    uint16_t targetPhysCellId;

    bool haveCarrierFreq;