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

/*

 * Copyright (c) 2011 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: Nicola Baldo <nbaldo@cttc.es>

 */

#ifndef LTE_UE_CMAC_SAP_H

#define LTE_UE_CMAC_SAP_H

#include <ns3/packet.h>

#include <ns3/ff-mac-common.h>

#include <ns3/eps-bearer.h>

#include <ns3/lte-common.h>

namespace ns3 {

class LteMacSapUser;

/**

 * Service Access Point (SAP) offered by the UE MAC to the UE RRC

 *

 * This is the MAC SAP Provider, i.e., the part of the SAP that contains the MAC methods called by the RRC

 */

class LteUeCmacSapProvider

{

public:

  virtual ~LteUeCmacSapProvider ();

  struct RachConfig

  {

    uint8_t numberOfRaPreambles;

    uint8_t preambleTransMax;

    uint8_t raResponseWindowSize;

  };

  virtual void ConfigureRach (RachConfig rc) = 0;

  /** 

   * tell the MAC to start a contention-based random access procedure,

   * e.g., to perform RRC connection establishment 

   * 

   */

  virtual void StartContentionBasedRandomAccessProcedure () = 0;

  /** 

   * tell the MAC to start a non-contention-based random access

   * procedure, e.g., as a consequence of handover

   * 

   * \param rnti

   * \param rapId Random Access Preamble Identifier

   * \param prachMask 

   */

  virtual void StartNonContentionBasedRandomAccessProcedure (uint16_t rnti, uint8_t rapId, uint8_t prachMask) = 0;

  struct LogicalChannelConfig

  {

    uint8_t priority;

    uint16_t prioritizedBitRateKbps;

    uint16_t bucketSizeDurationMs;

    uint8_t logicalChannelGroup;

  };

  /** 

   * add a new Logical Channel (LC) 

   * 

   * \param lcId the ID of the LC

   * \param lcConfig the LC configuration provided by the RRC

   * \param msu the corresponding LteMacSapUser

   */

  virtual void AddLc (uint8_t lcId, LogicalChannelConfig lcConfig, LteMacSapUser* msu) = 0;

  /** 

   * remove an existing LC

   * 

   * \param lcId 

   */

  virtual void RemoveLc (uint8_t lcId) = 0;

  /** 

   * reset the MAC

   * 

   */

  virtual void Reset () = 0;

};

/**

 * Service Access Point (SAP) offered by the UE MAC to the UE RRC

 *

 * This is the MAC SAP User, i.e., the part of the SAP that contains the RRC methods called by the MAC

 */

class LteUeCmacSapUser

{

public:

  virtual ~LteUeCmacSapUser ();

  /** 

   * 

   * 

   * \param rnti the T-C-RNTI, which will eventually become the C-RNTI after contention resolution

   */

  virtual void SetTemporaryCellRnti (uint16_t rnti) = 0;

  /** 

   * Notify the RRC that the MAC Random Access procedure completed successfully

   * 

   */

  virtual void NotifyRandomAccessSuccessful () = 0;

  /** 

   * Notify the RRC that the MAC Random Access procedure failed

   * 

   */

  virtual void NotifyRandomAccessFailed () = 0;

};

} // namespace ns3

#endif // LTE_UE_CMAC_SAP_H