srsLTE/srsue/hdr/stack/mac_nr/mac_nr.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2021 Software Radio Systems Limited
 *
 * By using this file, you agree to the terms and conditions set
 * forth in the LICENSE file which can be found at the top level of
 * the distribution.
 *
 */

#ifndef SRSUE_MAC_NR_H
#define SRSUE_MAC_NR_H

#include "dl_harq_nr.h"
#include "mac_nr_interfaces.h"
#include "proc_bsr_nr.h"
#include "proc_ra_nr.h"
#include "proc_sr_nr.h"
#include "srsran/common/mac_pcap.h"
#include "srsran/interfaces/mac_interface_types.h"
#include "srsran/interfaces/ue_nr_interfaces.h"
#include "srsran/srslog/srslog.h"
#include "srsue/hdr/stack/mac_common/mac_common.h"
#include "srsue/hdr/stack/mac_nr/demux_nr.h"
#include "srsue/hdr/stack/mac_nr/mux_nr.h"
#include "srsue/hdr/stack/ue_stack_base.h"
#include "ul_harq_nr.h"

namespace srsue {

class rlc_interface_mac;

struct mac_nr_args_t {};

class mac_nr final : public mac_interface_phy_nr,
                     public mac_interface_rrc_nr,
                     public mac_interface_proc_ra_nr,
                     public mac_interface_sr_nr,
                     public mac_interface_mux_nr,
                     public mac_interface_harq_nr
{
public:
  mac_nr(srsran::ext_task_sched_handle task_sched_);
  ~mac_nr();

  int  init(const mac_nr_args_t& args_, phy_interface_mac_nr* phy_, rlc_interface_mac* rlc_, rrc_interface_mac* rrc_);
  void stop();

  void run_tti(const uint32_t tti);

  void start_pcap(srsran::mac_pcap* pcap_);

  void bch_decoded_ok(uint32_t tti, srsran::unique_byte_buffer_t payload);

  /// Interface for PHY
  sched_rnti_t get_dl_sched_rnti_nr(const uint32_t tti);
  sched_rnti_t get_ul_sched_rnti_nr(const uint32_t tti);

  int  sf_indication(const uint32_t tti);
  void tb_decoded(const uint32_t cc_idx, const mac_nr_grant_dl_t& grant, tb_action_dl_result_t result);
  void new_grant_dl(const uint32_t cc_idx, const mac_nr_grant_dl_t& grant, tb_action_dl_t* action);
  void new_grant_ul(const uint32_t cc_idx, const mac_nr_grant_ul_t& grant, tb_action_ul_t* action);
  void prach_sent(const uint32_t tti,
                  const uint32_t s_id,
                  const uint32_t t_id,
                  const uint32_t f_id,
                  const uint32_t ul_carrier_id);
  bool sr_opportunity(uint32_t tti, uint32_t sr_id, bool meas_gap, bool ul_sch_tx);

  /// Stack interface
  void timer_expired(uint32_t timer_id);
  void get_metrics(mac_metrics_t* metrics);

  /// Interface for RRC (RRC -> MAC)
  void reset();
  int  setup_lcid(const srsran::logical_channel_config_t& config);
  int  set_config(const srsran::bsr_cfg_nr_t& bsr_cfg);
  int  set_config(const srsran::sr_cfg_nr_t& sr_cfg);
  void set_config(const srsran::rach_nr_cfg_t& rach_cfg);
  int  set_config(const srsran::dl_harq_cfg_nr_t& dl_hrq_cfg);
  void set_contention_id(const uint64_t ue_identity);
  bool set_crnti(const uint16_t crnti);
  int  add_tag_config(const srsran::tag_cfg_nr_t& tag_cfg);
  int  set_config(const srsran::phr_cfg_nr_t& phr_cfg);
  int  remove_tag_config(const uint32_t tag_id);
  void start_ra_procedure();

  /// Interface for internal procedures (RA, MUX, HARQ)
  uint64_t get_contention_id();
  uint16_t get_crnti();
  uint16_t get_temp_crnti();
  uint16_t get_csrnti() { return SRSRAN_INVALID_RNTI; }; // SPS not supported

  /// procedure sr nr interface
  void start_ra() { proc_ra.start_by_mac(); }

  /// Interface for MUX
  srsran::mac_sch_subpdu_nr::lcg_bsr_t generate_sbsr();
  void                                 set_padding_bytes(uint32_t nof_bytes);

  void msg3_flush() { mux.msg3_flush(); }
  bool msg3_is_transmitted() { return mux.msg3_is_transmitted(); }
  void msg3_prepare() { mux.msg3_prepare(); }
  bool msg3_is_pending() { return mux.msg3_is_pending(); }
  bool msg3_is_empty() { return mux.msg3_is_empty(); }

  /// RRC
  void rrc_ra_problem();
  void rrc_ra_completed();

  /// stack interface
  void process_pdus();

  static bool is_in_window(uint32_t tti, int* start, int* len);

private:
  void write_pcap(const uint32_t           cc_idx,
                  const mac_nr_grant_dl_t& grant,
                  tb_action_dl_result_t&   tb); // If PCAPs are enabled for this MAC
  void handle_pdu(srsran::unique_byte_buffer_t pdu);
  void get_ul_data(const mac_nr_grant_ul_t& grant, srsran::byte_buffer_t* tx_pdu);

  // temporary helper
  void handle_rar_pdu(mac_nr_grant_dl_t& grant);

  bool is_si_opportunity();
  bool is_paging_opportunity();

  bool has_crnti();
  bool is_valid_crnti(const uint16_t crnti);

  std::vector<srsran::logical_channel_config_t> logical_channels; // stores the raw configs provide by upper layers

  /// LCID and LCG related members and helper functions
  void                update_buffer_states();
  mac_buffer_states_t mac_buffer_states;

  /// Interaction with rest of the stack
  phy_interface_mac_nr*         phy = nullptr;
  rlc_interface_mac*            rlc = nullptr;
  rrc_interface_mac*            rrc = nullptr;
  srsran::ext_task_sched_handle task_sched;

  srsran::mac_pcap*     pcap = nullptr;
  srslog::basic_logger& logger;
  mac_nr_args_t         args = {};

  std::atomic<bool> started = {false};

  ue_rnti rntis; // thread-safe helper to store RNTIs, contention ID, etc

  std::array<mac_metrics_t, SRSRAN_MAX_CARRIERS> metrics = {};

  srsran::task_multiqueue::queue_handle stack_task_dispatch_queue;

  // MAC Uplink-related procedures
  proc_ra_nr  proc_ra;
  proc_sr_nr  proc_sr;
  proc_bsr_nr proc_bsr;
  mux_nr      mux;
  demux_nr    demux;

  // DL/UL HARQ
  dl_harq_entity_nr_vector dl_harq = {};
  ul_harq_entity_nr_vector ul_harq = {};

  const uint8_t PCELL_CC_IDX = 0;
};

} // namespace srsue

#endif // SRSUE_MAC_NR_H