Frame processor for MBSFN subframes. More...

#include <MbsfnFrameProcessor.h>

Collaboration diagram for MbsfnFrameProcessor:

Public Member Functions
	MbsfnFrameProcessor (const libconfig::Config &cfg, srsran::rlc &rlc, Phy &phy, srslog::basic_logger &log_h, RestHandler &rest, unsigned rx_channels)
	Default constructor. More...

virtual	~MbsfnFrameProcessor ()
	Default destructor. More...

bool	init ()
	Initialize signal- and softbuffers, init all underlying components. More...

int	process (uint32_t tti)
	Process the sample data in the signal buffer. More...

void	set_cell (srsran_cell_t cell)
	Set the parameters for the cell (Nof PRB, etc). More...

cf_t **	get_rx_buffer_and_lock ()
	Get a handle of the signal buffer to store samples for processing in, and lock this processor. More...

uint32_t	rx_buffer_size ()
	Size of the signal buffer. More...

void	configure_mbsfn (uint8_t area_id, srsran_scs_t subcarrier_spacing)
	Set MBSFN parameters: area ID and subcarrier spacing. More...

bool	mbsfn_configured ()
	Returns tru if MBSFN params have already been configured. More...

void	unlock ()
	Unlock the processor. More...

void	lock ()
	Lock the processor. More...

const std::vector< uint8_t >	mch_data () const
	Get the constellation diagram data (I/Q data of the subcarriers after CE) More...

float	cinr_db ()
	Get the CINR estimate (in dB) More...

Private Attributes
const libconfig::Config &	_cfg

srsran::rlc &	_rlc

Phy &	_phy

srsran_cell_t	_cell

cf_t *	_signal_buffer_rx [SRSRAN_MAX_PORTS] = {}

uint32_t	_signal_buffer_max_samples = 0

uint8_t	_payload_buffer [_payload_buffer_sz]

srsran_softbuffer_rx_t	_softbuffer

srsran_ue_dl_t	_ue_dl = {}

srsran_ue_dl_cfg_t	_ue_dl_cfg = {}

srsran_dl_sf_cfg_t	_sf_cfg = {}

srsran_pmch_cfg_t	_pmch_cfg = {}

uint8_t	_area_id = 1

bool	_mbsfn_configured = false

srsran::mch_pdu	mch_mac_msg

std::mutex	_mutex

RestHandler &	_rest

unsigned	_rx_channels

bool	_allow_rrc_sn_across_periods = false

Static Private Attributes
static const uint32_t	_payload_buffer_sz = SRSRAN_MAX_BUFFER_SIZE_BYTES

static std::mutex	_sched_stop_mutex

static std::map< uint8_t, uint16_t >	_sched_stops

static std::mutex	_rlc_mutex

static int	_current_mcs

Detailed Description

Frame processor for MBSFN subframes.

Handles the complete processing chain for a CAS subframe: calls FFT and channel estimation, decodes PDSCH and passes received PDUs to RLC.

Definition at line 39 of file MbsfnFrameProcessor.h.

Constructor & Destructor Documentation

◆ MbsfnFrameProcessor()

MbsfnFrameProcessor::MbsfnFrameProcessor	(	const libconfig::Config &	cfg,
		srsran::rlc &	rlc,
		Phy &	phy,
		srslog::basic_logger &	log_h,
		RestHandler &	rest,
		unsigned	rx_channels
	)

inline

Default constructor.

Parameters

cfg	Config singleton reference
phy	PHY reference
rlc	RLC reference
log_h	srsLTE log handle for the MCH MAC msg decoder
rest	RESTful API handler reference

Definition at line 50 of file MbsfnFrameProcessor.h.

       : _cfg(cfg)
       , _rlc(rlc)
       , _phy(phy)
       , _rest(rest)
       , mch_mac_msg(20, log_h)
       , _rx_channels(rx_channels)
       {
         _allow_rrc_sn_across_periods = false;
         cfg.lookupValue("modem.phy.allow_rrc_sn_across_periods", _allow_rrc_sn_across_periods); 
       }

◆ ~MbsfnFrameProcessor()

MbsfnFrameProcessor::~MbsfnFrameProcessor ( )

virtual

Default destructor.

Definition at line 73 of file MbsfnFrameProcessor.cpp.

                                           {
   srsran_softbuffer_rx_free(&_softbuffer);
   srsran_ue_dl_free(&_ue_dl);
 }

Member Function Documentation

◆ cinr_db()

float MbsfnFrameProcessor::cinr_db ( )

inline

Get the CINR estimate (in dB)

Definition at line 135 of file MbsfnFrameProcessor.h.

135 { return _ue_dl.chest_res.snr_db; }

◆ configure_mbsfn()

void MbsfnFrameProcessor::configure_mbsfn	(	uint8_t	area_id,
		srsran_scs_t	subcarrier_spacing
	)

Set MBSFN parameters: area ID and subcarrier spacing.

Definition at line 246 of file MbsfnFrameProcessor.cpp.

                                                                                           {
   _sf_cfg.subcarrier_spacing = subcarrier_spacing;
   srsran_ue_dl_set_mbsfn_subcarrier_spacing(&_ue_dl, subcarrier_spacing);
  
  
   srsran_ue_dl_set_mbsfn_area_id(&_ue_dl, area_id);
   _area_id = area_id;
   _mbsfn_configured = true;
 }

◆ get_rx_buffer_and_lock()

cf_t** MbsfnFrameProcessor::get_rx_buffer_and_lock ( )

inline

Get a handle of the signal buffer to store samples for processing in, and lock this processor.

The processor unlocks itself after (failed or successful) frame processing in process(). If process() is not called by the application after calling this method, it must unlock the processor itself by calling unlock()

Definition at line 96 of file MbsfnFrameProcessor.h.

96 { _mutex.lock(); return _signal_buffer_rx; }

MbsfnFrameProcessor::_signal_buffer_rx

cf_t * _signal_buffer_rx[SRSRAN_MAX_PORTS]

Definition: MbsfnFrameProcessor.h:144

MbsfnFrameProcessor::_mutex

std::mutex _mutex

Definition: MbsfnFrameProcessor.h:160

◆ init()

auto MbsfnFrameProcessor::init ( )

Initialize signal- and softbuffers, init all underlying components.

Must be called once before the first call to process().

Definition at line 28 of file MbsfnFrameProcessor.cpp.

                                        {
   _signal_buffer_max_samples = 3 * SRSRAN_SF_LEN_PRB(MAX_PRB);
  
   for (auto ch = 0; ch < _rx_channels; ch++) {
     _signal_buffer_rx[ch] = srsran_vec_cf_malloc(_signal_buffer_max_samples);
     if (!_signal_buffer_rx[ch]) {
       spdlog::error("Could not allocate regular DL signal buffer\n");
       return false;
     }
   }
  
   if (srsran_ue_dl_init(&_ue_dl, _signal_buffer_rx, MAX_PRB, _rx_channels) != 0) {
     spdlog::error("Could not init ue_dl\n");
     return false;;
   }
  
   srsran_softbuffer_rx_init(&_softbuffer, 100);
  
   _ue_dl_cfg.snr_to_cqi_offset = 0;
  
   srsran_chest_dl_cfg_t* chest_cfg = &_ue_dl_cfg.chest_cfg;
   bzero(chest_cfg, sizeof(srsran_chest_dl_cfg_t));
   chest_cfg->filter_coef[0] = 0.1;
   chest_cfg->filter_type = SRSRAN_CHEST_FILTER_NONE;
   chest_cfg->noise_alg = SRSRAN_NOISE_ALG_EMPTY;
   chest_cfg->rsrp_neighbour       = false;
   chest_cfg->sync_error_enable    = true;
   chest_cfg->estimator_alg = SRSRAN_ESTIMATOR_ALG_INTERPOLATE;
   chest_cfg->cfo_estimate_enable  = false;
  
   _ue_dl_cfg.cfg.pdsch.csi_enable         = true;
   _ue_dl_cfg.cfg.pdsch.max_nof_iterations = 8;
   _ue_dl_cfg.cfg.pdsch.meas_evm_en        = false;
   _ue_dl_cfg.cfg.pdsch.decoder_type       = SRSRAN_MIMO_DECODER_MMSE;
   _ue_dl_cfg.cfg.pdsch.softbuffers.rx[0] = &_softbuffer;
  
   _pmch_cfg.pdsch_cfg.csi_enable         = true;
   _pmch_cfg.pdsch_cfg.max_nof_iterations = 8;
   _pmch_cfg.pdsch_cfg.meas_evm_en        = false;
   _pmch_cfg.pdsch_cfg.decoder_type       = SRSRAN_MIMO_DECODER_MMSE;
  
   _sf_cfg.sf_type = SRSRAN_SF_MBSFN;
   return true;
 }

◆ lock()

void MbsfnFrameProcessor::lock ( )

inline

Lock the processor.

Used when getting the BLER values.

Definition at line 125 of file MbsfnFrameProcessor.h.

125 { _mutex.lock(); }

◆ mbsfn_configured()

bool MbsfnFrameProcessor::mbsfn_configured ( )

inline

Returns tru if MBSFN params have already been configured.

Definition at line 111 of file MbsfnFrameProcessor.h.

111 { return _mbsfn_configured; }

◆ mch_data()

auto MbsfnFrameProcessor::mch_data ( ) const

Get the constellation diagram data (I/Q data of the subcarriers after CE)

Definition at line 256 of file MbsfnFrameProcessor.cpp.

                                                                      {
   const uint8_t* data = reinterpret_cast<uint8_t*>(_ue_dl.pmch.d);
   return std::move(std::vector<uint8_t>( data, data + _pmch_cfg.pdsch_cfg.grant.nof_re * sizeof(cf_t)));
 }

◆ process()

auto MbsfnFrameProcessor::process ( uint32_t tti )

Process the sample data in the signal buffer.

Data must already be present in the buffer obtained through the handle returnd by rx_buffer()

Parameters

tti	TTI of the subframe the data belongs to

Definition at line 83 of file MbsfnFrameProcessor.cpp.

                                                      {
   spdlog::trace("Processing MBSFN TTI {}", tti);
  
   uint32_t sfn = tti / 10;
   uint8_t sf = tti % 10;
  
   unsigned mch_idx = 0;
   _sf_cfg.tti = tti;
   _pmch_cfg.area_id = _area_id;
   srsran_mbsfn_cfg_t mbsfn_cfg = _phy.mbsfn_config_for_tti(tti, mch_idx);
   _ue_dl_cfg.chest_cfg.mbsfn_area_id = _area_id;
   //srsran_ue_dl_set_mbsfn_area_id(&_ue_dl, mbsfn_cfg.mbsfn_area_id);
  
   if (!_cell.mbms_dedicated) {
     srsran_ue_dl_set_non_mbsfn_region(&_ue_dl, mbsfn_cfg.non_mbsfn_region_length);
   }
  
   if (!mbsfn_cfg.enable) {
     spdlog::trace("PMCH: tti {}: neither MCCH nor MCH enabled. Skipping subframe");
     _mutex.unlock();
     return -1;
   }
  
   if (mbsfn_cfg.is_mcch) {
     _rest._mcch.total++;
   } else {
     _rest._mch[mch_idx].total++;
   }
  
   if (srsran_ue_dl_decode_fft_estimate(&_ue_dl, &_sf_cfg, &_ue_dl_cfg) < 0) {
     if (mbsfn_cfg.is_mcch) {
       _rest._mcch.errors++;
     } else {
       _rest._mch[mch_idx].errors++;
     }
     spdlog::error("Getting PDCCH FFT estimate");
     _mutex.unlock();
     return -1;
   }
  
   srsran_configure_pmch(&_pmch_cfg, &_cell, &mbsfn_cfg);
   srsran_ra_dl_compute_nof_re(&_cell, &_sf_cfg, &_pmch_cfg.pdsch_cfg.grant);
  
   _pmch_cfg.area_id = _area_id;
  
   srsran_softbuffer_rx_reset_cb(&_softbuffer, 1);
  
   srsran_pdsch_res_t pmch_dec = {};
   _pmch_cfg.pdsch_cfg.softbuffers.rx[0] = &_softbuffer;
   pmch_dec.payload = _payload_buffer;
   srsran_softbuffer_rx_reset_tbs(_pmch_cfg.pdsch_cfg.softbuffers.rx[0], _pmch_cfg.pdsch_cfg.grant.tb[0].tbs);
  
   if (srsran_ue_dl_decode_pmch(&_ue_dl, &_sf_cfg, &_pmch_cfg, &pmch_dec) != 0) {
     if (mbsfn_cfg.is_mcch) {
       _rest._mcch.errors++;
     } else {
       _rest._mch[mch_idx].errors++;
     }
     spdlog::warn("Error decoding PMCH");
     _mutex.unlock();
     return -1;
   }
  
   spdlog::trace("PMCH: tti: {}, l_crb={}, tbs={}, mcs={}, crc={}, snr={} dB, n_iter={}\n",
       tti,
          _pmch_cfg.pdsch_cfg.grant.nof_prb,
          _pmch_cfg.pdsch_cfg.grant.tb[0].tbs / 8,
          _pmch_cfg.pdsch_cfg.grant.tb[0].mcs_idx,
          pmch_dec.crc ? "OK" : "KO",
          _ue_dl.chest_res.snr_db,
          pmch_dec.avg_iterations_block);
  
   if (mbsfn_cfg.is_mcch) {
     _rest._mcch.SetData(mch_data());
     _rest._mcch.mcs = _pmch_cfg.pdsch_cfg.grant.tb[0].mcs_idx;
   } else {
     _rest._mch[mch_idx].SetData(mch_data());
     _rest._mch[mch_idx].mcs = _pmch_cfg.pdsch_cfg.grant.tb[0].mcs_idx;
     _rest._mch[mch_idx].present = true;
   }
  
   if (pmch_dec.crc) {
     mch_mac_msg.init_rx(
         static_cast<uint32_t>(_pmch_cfg.pdsch_cfg.grant.tb[0].tbs) / 8);
     mch_mac_msg.parse_packet(_payload_buffer);
  
     while (mch_mac_msg.next()) {
       if (srsran::mch_lcid::MCH_SCHED_INFO == mch_mac_msg.get()->mch_ce_type()) {
         uint16_t stop = 0;
         uint8_t lcid = 0;
         while (mch_mac_msg.get()->get_next_mch_sched_info(&lcid, &stop)) {
           const std::lock_guard<std::mutex> lock(_sched_stop_mutex);
           spdlog::debug("Scheduling stop for LCID {} in sf {}", lcid, stop);
           _sched_stops[ lcid ] = stop;
         }
       } else if (mch_mac_msg.get()->is_sdu()) {
         uint32_t lcid = mch_mac_msg.get()->get_sdu_lcid();
         spdlog::trace("Processing MAC MCH PDU entered, lcid {}", lcid);
  
         if (lcid >= SRSRAN_N_MCH_LCIDS) {
           spdlog::warn("Radio bearer id must be in [0:%d] - %d", SRSRAN_N_MCH_LCIDS, lcid);
           if (mbsfn_cfg.is_mcch) {
             _rest._mcch.errors++;
           } else {
             _rest._mch[mch_idx].errors++;
           }
           _mutex.unlock();
           return -1;
         }
  
         {
           _phy._mcs = mbsfn_cfg.mbsfn_mcs;
           const std::lock_guard<std::mutex> lock(_rlc_mutex);
           _rlc.write_pdu_mch(mch_idx, lcid, mch_mac_msg.get()->get_sdu_ptr(), mch_mac_msg.get()->get_payload_size());
         }
       }
     }
   } else {
     if (mbsfn_cfg.is_mcch) {
       _rest._mcch.errors++;
     } else {
       _rest._mch[mch_idx].errors++;
     }
  
     spdlog::trace("PMCH in TTI {} failed with CRC error", tti);
     _mutex.unlock();
     return -1;
   }
  
   if (!mbsfn_cfg.is_mcch) {
     for (uint32_t i = 0; i < _phy.mcch().nof_pmch_info; i++) {
       unsigned fn_in_scheduling_period =  sfn % srsran::enum_to_number(_phy.mcch().pmch_info_list[i].mch_sched_period);
       unsigned sf_idx;
       if (_cell.mbms_dedicated) {
         sf_idx = fn_in_scheduling_period * 10 + sf - (fn_in_scheduling_period / 4) - 1;
       } else {
         sf_idx = fn_in_scheduling_period * 6 + (sf < 6 ? sf - 1 : sf - 3);
       }
           spdlog::debug("tti{}, sfn {}, sf {}, fn_in_scheduling_period {}, sf_idf {}", tti, sfn, sf, fn_in_scheduling_period, sf_idx);
  
       const std::lock_guard<std::mutex> lock(_sched_stop_mutex);
       for (auto itr = _sched_stops.cbegin() ; itr != _sched_stops.cend() ;) {
         if ( sf_idx >= itr->second ) {
           spdlog::debug("Stopping LCID {} in tti {} (idx in rf {})", itr->first, tti, sf_idx);
           const std::lock_guard<std::mutex> lock(_rlc_mutex);
           if (!_allow_rrc_sn_across_periods) {
             _rlc.stop_mch(i, itr->first);
           }
           itr = _sched_stops.erase(itr);
         } else {
           itr = std::next(itr);
         }
       }
     }
   } else {
     const std::lock_guard<std::mutex> lock(_rlc_mutex);
     _rlc.stop_mch(0, 0);
     _rest._mcch.present = true;
   }
   _mutex.unlock();
   return mbsfn_cfg.is_mcch ? 0 : 1;
 }

◆ rx_buffer_size()

uint32_t MbsfnFrameProcessor::rx_buffer_size ( )

inline

Size of the signal buffer.

Definition at line 101 of file MbsfnFrameProcessor.h.

101 { return _signal_buffer_max_samples; }

◆ set_cell()

void MbsfnFrameProcessor::set_cell ( srsran_cell_t cell )

Set the parameters for the cell (Nof PRB, etc).

Parameters

cell	The cell we're camping on

Definition at line 78 of file MbsfnFrameProcessor.cpp.

                                                      {
   _cell = cell;
   srsran_ue_dl_set_cell(&_ue_dl, cell);
 }

◆ unlock()

void MbsfnFrameProcessor::unlock ( )

inline

Unlock the processor.

See also: get_rx_buffer_and_lock()

Definition at line 118 of file MbsfnFrameProcessor.h.

118 { _mutex.unlock(); }

Member Data Documentation

◆ _allow_rrc_sn_across_periods

bool MbsfnFrameProcessor::_allow_rrc_sn_across_periods = false

private

Definition at line 166 of file MbsfnFrameProcessor.h.

◆ _area_id

uint8_t MbsfnFrameProcessor::_area_id = 1

private

Definition at line 156 of file MbsfnFrameProcessor.h.

◆ _cell

srsran_cell_t MbsfnFrameProcessor::_cell

private

Definition at line 142 of file MbsfnFrameProcessor.h.

◆ _cfg

const libconfig::Config& MbsfnFrameProcessor::_cfg

private

Definition at line 138 of file MbsfnFrameProcessor.h.

◆ _current_mcs

int MbsfnFrameProcessor::_current_mcs

staticprivate

Definition at line 171 of file MbsfnFrameProcessor.h.

◆ _mbsfn_configured

bool MbsfnFrameProcessor::_mbsfn_configured = false

private

Definition at line 157 of file MbsfnFrameProcessor.h.

◆ _mutex

std::mutex MbsfnFrameProcessor::_mutex

private

Definition at line 160 of file MbsfnFrameProcessor.h.

◆ _payload_buffer

uint8_t MbsfnFrameProcessor::_payload_buffer[_payload_buffer_sz]

private

Definition at line 148 of file MbsfnFrameProcessor.h.

◆ _payload_buffer_sz

const uint32_t MbsfnFrameProcessor::_payload_buffer_sz = SRSRAN_MAX_BUFFER_SIZE_BYTES

staticprivate

Definition at line 147 of file MbsfnFrameProcessor.h.

◆ _phy

Phy& MbsfnFrameProcessor::_phy

private

Definition at line 140 of file MbsfnFrameProcessor.h.

◆ _pmch_cfg

srsran_pmch_cfg_t MbsfnFrameProcessor::_pmch_cfg = {}

private

Definition at line 154 of file MbsfnFrameProcessor.h.

◆ _rest

RestHandler& MbsfnFrameProcessor::_rest

private

Definition at line 162 of file MbsfnFrameProcessor.h.

◆ _rlc

srsran::rlc& MbsfnFrameProcessor::_rlc

private

Definition at line 139 of file MbsfnFrameProcessor.h.

◆ _rlc_mutex

std::mutex MbsfnFrameProcessor::_rlc_mutex

staticprivate

Definition at line 170 of file MbsfnFrameProcessor.h.

◆ _rx_channels

unsigned MbsfnFrameProcessor::_rx_channels

private

Definition at line 164 of file MbsfnFrameProcessor.h.

◆ _sched_stop_mutex

std::mutex MbsfnFrameProcessor::_sched_stop_mutex

staticprivate

Definition at line 167 of file MbsfnFrameProcessor.h.

◆ _sched_stops

std::map< uint8_t, uint16_t > MbsfnFrameProcessor::_sched_stops

staticprivate

Definition at line 168 of file MbsfnFrameProcessor.h.

◆ _sf_cfg

srsran_dl_sf_cfg_t MbsfnFrameProcessor::_sf_cfg = {}

private

Definition at line 153 of file MbsfnFrameProcessor.h.

◆ _signal_buffer_max_samples

uint32_t MbsfnFrameProcessor::_signal_buffer_max_samples = 0

private

Definition at line 145 of file MbsfnFrameProcessor.h.

◆ _signal_buffer_rx

cf_t* MbsfnFrameProcessor::_signal_buffer_rx[SRSRAN_MAX_PORTS] = {}

private

Definition at line 144 of file MbsfnFrameProcessor.h.

◆ _softbuffer

srsran_softbuffer_rx_t MbsfnFrameProcessor::_softbuffer

private

Definition at line 149 of file MbsfnFrameProcessor.h.

◆ _ue_dl

srsran_ue_dl_t MbsfnFrameProcessor::_ue_dl = {}

private

Definition at line 151 of file MbsfnFrameProcessor.h.

◆ _ue_dl_cfg

srsran_ue_dl_cfg_t MbsfnFrameProcessor::_ue_dl_cfg = {}

private

Definition at line 152 of file MbsfnFrameProcessor.h.

◆ mch_mac_msg

srsran::mch_pdu MbsfnFrameProcessor::mch_mac_msg

private

Definition at line 159 of file MbsfnFrameProcessor.h.

The documentation for this class was generated from the following files:

src/MbsfnFrameProcessor.h
src/MbsfnFrameProcessor.cpp

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MbsfnFrameProcessor()

◆ ~MbsfnFrameProcessor()

Member Function Documentation

◆ cinr_db()

◆ configure_mbsfn()

◆ get_rx_buffer_and_lock()

◆ init()

◆ lock()

◆ mbsfn_configured()

◆ mch_data()

◆ process()

◆ rx_buffer_size()

◆ set_cell()

◆ unlock()

Member Data Documentation

◆ _allow_rrc_sn_across_periods

◆ _area_id

◆ _cell

◆ _cfg

◆ _current_mcs

◆ _mbsfn_configured

◆ _mutex

◆ _payload_buffer

◆ _payload_buffer_sz

◆ _phy

◆ _pmch_cfg

◆ _rest

◆ _rlc

◆ _rlc_mutex

◆ _rx_channels

◆ _sched_stop_mutex

◆ _sched_stops

◆ _sf_cfg

◆ _signal_buffer_max_samples

◆ _signal_buffer_rx

◆ _softbuffer

◆ _ue_dl

◆ _ue_dl_cfg

◆ mch_mac_msg