Frame processor for CAS subframes. More...

#include <CasFrameProcessor.h>

Collaboration diagram for CasFrameProcessor:

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

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

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

bool	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. More...

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

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

void	lock ()

std::vector< uint8_t >	ce_values ()
	Get the CE values (time domain) for displaying the spectrum of the received signal. More...

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

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

void	set_filter_order (uint8_t filter_order)
	Set the filter order used to filter the channel estimates. More...

uint8_t	get_filter_order ()

void	set_filter_coef (float filter_coef)
	Set the coef for gauss filtering. More...

float	get_filter_coef ()

void	set_filter_type (srsran_chest_filter_t filter_type)
	Set the filter type for chest. More...

uint8_t	get_filter_type ()

void	set_noise_alg (srsran_chest_dl_noise_alg_t noise_alg)
	Set the noise estimation algorithm used in the channel estimation stage. More...

uint8_t	get_noise_alg ()

void	set_sync_error (bool enable)
	Enables the estimation os synchronization error. More...

bool	get_sync_error ()

void	set_estimator_alg (srsran_chest_dl_estimator_alg_t estimator_alg)
	Set the method to estimate the channel estimates of the complete resource grid from the reference symbols. More...

uint8_t	get_estimator_alg ()

void	set_cfo_estimate (bool enable)
	Enables the estimation of the carrier frequency offset. More...

bool	get_cfo_estimate ()

void	set_evm_meas (bool enable)
	Enables the computation of the error vector magnitude on the PDSCH. More...

bool	get_evm_meas ()

bool	is_started ()
	Returns if the CasFrameProcessor is started or not. More...

Private Attributes
const libconfig::Config &	_cfg

srsran::rlc &	_rlc

Phy &	_phy

RestHandler &	_rest

cf_t *	_signal_buffer_rx [SRSRAN_MAX_PORTS] = {}

uint32_t	_signal_buffer_max_samples = 0

srsran_softbuffer_rx_t	_softbuffer

uint8_t *	_data [SRSRAN_MAX_CODEWORDS]

srsran_ue_dl_t	_ue_dl = {}

srsran_ue_dl_cfg_t	_ue_dl_cfg = {}

srsran_dl_sf_cfg_t	_sf_cfg = {}

srsran_cell_t	_cell

std::mutex	_mutex

unsigned	_rx_channels

bool	_started = 0

Detailed Description

Frame processor for CAS subframes.

Handles the complete processing chain for a CAS subframe: calls FFT and channel estimation, decodes PCFICH and PDCCH and gets DCI(s), decodes PDSCH and passes received PDUs to RLC.

Definition at line 37 of file CasFrameProcessor.h.

Constructor & Destructor Documentation

◆ CasFrameProcessor()

CasFrameProcessor::CasFrameProcessor	(	const libconfig::Config &	cfg,
		Phy &	phy,
		srsran::rlc &	rlc,
		RestHandler &	rest,
		unsigned	rx_channels
	)

inline

Default constructor.

Parameters

cfg	Config singleton reference
phy	PHY reference
rlc	RLC reference
rest	RESTful API handler reference

Definition at line 47 of file CasFrameProcessor.h.

      : _cfg(cfg)
      , _phy(phy)
      , _rest(rest)
      , _rlc(rlc)
      , _rx_channels(rx_channels)
      {}

◆ ~CasFrameProcessor()

CasFrameProcessor::~CasFrameProcessor ( )

virtual

Default destructor.

Definition at line 74 of file CasFrameProcessor.cpp.

                                       {
   for (auto & i : _data) {
     if (i) {
       free(i);
     }
   }
   srsran_softbuffer_rx_free(&_softbuffer);
   srsran_ue_dl_free(&_ue_dl);
 }

Member Function Documentation

◆ ce_values()

auto CasFrameProcessor::ce_values ( )

Get the CE values (time domain) for displaying the spectrum of the received signal.

Definition at line 163 of file CasFrameProcessor.cpp.

                                                         {
   auto sz = (uint32_t)srsran_symbol_sz(_cell.nof_prb);
   std::vector<float> ce_abs;
   ce_abs.resize(sz, 0);
   uint32_t g = (sz - 12 * _cell.nof_prb) / 2;
   srsran_vec_abs_dB_cf(_ue_dl.chest_res.ce[0][0], -80, &ce_abs[g], SRSRAN_NRE * _cell.nof_prb);
   const uint8_t* data = reinterpret_cast<uint8_t*>(ce_abs.data());
   return std::vector<uint8_t>( data, data + sz * sizeof(float));
 }

◆ cinr_db()

float CasFrameProcessor::cinr_db ( )

inline

Get the CINR estimate (in dB)

Definition at line 114 of file CasFrameProcessor.h.

114 { return _ue_dl.chest_res.snr_db; }

◆ get_cfo_estimate()

bool CasFrameProcessor::get_cfo_estimate ( )

inline

Definition at line 161 of file CasFrameProcessor.h.

161 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.cfo_estimate_enable); };

CasFrameProcessor::_ue_dl_cfg

srsran_ue_dl_cfg_t _ue_dl_cfg

Definition: CasFrameProcessor.h:187

◆ get_estimator_alg()

uint8_t CasFrameProcessor::get_estimator_alg ( )

inline

Definition at line 155 of file CasFrameProcessor.h.

155 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.estimator_alg); };

◆ get_evm_meas()

bool CasFrameProcessor::get_evm_meas ( )

inline

Definition at line 167 of file CasFrameProcessor.h.

167 { return static_cast<uint8_t>(_ue_dl_cfg.cfg.pdsch.meas_evm_en); };

◆ get_filter_coef()

float CasFrameProcessor::get_filter_coef ( )

inline

Definition at line 131 of file CasFrameProcessor.h.

131 { return static_cast<float>(_ue_dl_cfg.chest_cfg.filter_coef[1]); };

◆ get_filter_order()

uint8_t CasFrameProcessor::get_filter_order ( )

inline

Definition at line 125 of file CasFrameProcessor.h.

125 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.filter_coef[0]); };

◆ get_filter_type()

uint8_t CasFrameProcessor::get_filter_type ( )

inline

Definition at line 137 of file CasFrameProcessor.h.

137 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.filter_type); };

◆ get_noise_alg()

uint8_t CasFrameProcessor::get_noise_alg ( )

inline

Definition at line 143 of file CasFrameProcessor.h.

143 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.noise_alg); };

◆ get_rx_buffer_and_lock()

cf_t** CasFrameProcessor::get_rx_buffer_and_lock ( )

inline

Get a handle of the signal buffer to store samples for processing in.

Definition at line 84 of file CasFrameProcessor.h.

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

CasFrameProcessor::_signal_buffer_rx

cf_t * _signal_buffer_rx[SRSRAN_MAX_PORTS]

Definition: CasFrameProcessor.h:180

CasFrameProcessor::_mutex

std::mutex _mutex

Definition: CasFrameProcessor.h:191

◆ get_sync_error()

bool CasFrameProcessor::get_sync_error ( )

inline

Definition at line 149 of file CasFrameProcessor.h.

149 { return static_cast<uint8_t>(_ue_dl_cfg.chest_cfg.sync_error_enable); };

◆ init()

auto CasFrameProcessor::init ( )

Initialize signal- and softbuffers, init all underlying components.

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

Definition at line 24 of file CasFrameProcessor.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)) {
     spdlog::error("Could not init ue_dl\n");
     return false;;
   }
  
   srsran_softbuffer_rx_init(&_softbuffer, 100);
  
   _ue_dl_cfg.snr_to_cqi_offset = 0;
  
   for (auto & i : _data) {
     i = srsran_vec_u8_malloc(2000 * 8);
     if (!i) {
       spdlog::error("Allocating data");
       return false;
     }
   }
  
   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] = 4;
   chest_cfg->filter_coef[1] = 0.2f;
   chest_cfg->filter_type = SRSRAN_CHEST_FILTER_GAUSS;
   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_AVERAGE;
   chest_cfg->cfo_estimate_enable  = true;
   chest_cfg->cfo_estimate_sf_mask = 1023;
  
   _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;
  
   _sf_cfg.sf_type = SRSRAN_SF_NORM;
   return true;
 }

◆ is_started()

bool CasFrameProcessor::is_started ( )

inline

Returns if the CasFrameProcessor is started or not.

Definition at line 172 of file CasFrameProcessor.h.

172 { return _started; }

CasFrameProcessor::_started

bool _started

Definition: CasFrameProcessor.h:194

◆ lock()

void CasFrameProcessor::lock ( )

inline

Definition at line 98 of file CasFrameProcessor.h.

98 { _mutex.lock(); }

◆ pdsch_data()

auto CasFrameProcessor::pdsch_data ( )

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

Definition at line 173 of file CasFrameProcessor.cpp.

                                                          {
   const uint8_t* data = reinterpret_cast<uint8_t*>(_ue_dl.pdsch.d[0]);
   return std::vector<uint8_t>( data, data + _ue_dl_cfg.cfg.pdsch.grant.nof_re * sizeof(cf_t));
 }

◆ process()

auto CasFrameProcessor::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 91 of file CasFrameProcessor.cpp.

                                                     {
   _sf_cfg.tti = tti;
  
   _rest._pdsch.total++;
  
   // Run the FFT and do channel estimation
   if (srsran_ue_dl_decode_fft_estimate(&_ue_dl, &_sf_cfg, &_ue_dl_cfg) < 0) {
     _rest._pdsch.errors++;
     spdlog::error("Getting PDCCH FFT estimate\n");
     _mutex.unlock();
     return false;
   }
  
   // Feedback the CFO from CE to the Phy
   _phy.set_cfo_from_channel_estimation(_ue_dl.chest_res.cfo);
  
   // Try to decode DCIs from PDCCH
   srsran_dci_dl_t dci[SRSRAN_MAX_CARRIERS] = {};    // NOLINT
   int nof_grants = srsran_ue_dl_find_dl_dci(&_ue_dl, &_sf_cfg, &_ue_dl_cfg, _cell.mbms_dedicated ? SRSRAN_SIRNTI_MBMS_DEDICATED : SRSRAN_SIRNTI, dci);
   for (int k = 0; k < nof_grants; k++) {
     char str[512];  // NOLINT
     srsran_dci_dl_info(&dci[k], str, 512);
     _rest._pdsch.mcs =  dci[k].tb[0].mcs_idx;
     spdlog::debug("Decoded PDCCH: {}, snr={} dB\n", str, _ue_dl.chest_res.snr_db);
  
     if (srsran_ue_dl_dci_to_pdsch_grant(&_ue_dl, &_sf_cfg, &_ue_dl_cfg, &dci[k], &_ue_dl_cfg.cfg.pdsch.grant)) {
       spdlog::error("Converting DCI message to DL dci\n");
     _mutex.unlock();
       return false;
     }
  
     // We can construct a DL grant
     _ue_dl_cfg.cfg.pdsch.rnti = dci[k].rnti;
     srsran_pdsch_cfg_t* pdsch_cfg = &_ue_dl_cfg.cfg.pdsch;
  
     srsran_pdsch_res_t pdsch_res[SRSRAN_MAX_CODEWORDS] = {};  // NOLINT
     for (int i = 0; i < SRSRAN_MAX_CODEWORDS; i++) {
       if (pdsch_cfg->grant.tb[i].enabled) {
         if (pdsch_cfg->grant.tb[i].rv < 0) {
           uint32_t sfn              = tti / 10;
           uint32_t k                = (sfn / 2) % 4;
           pdsch_cfg->grant.tb[i].rv = ((int32_t)ceilf(static_cast<float>(1.5) * k)) % 4;
         }
         pdsch_res[i].payload = _data[i];
         pdsch_res[i].crc     = false;
         srsran_softbuffer_rx_reset_tbs(pdsch_cfg->softbuffers.rx[i], (uint32_t)pdsch_cfg->grant.tb[i].tbs);
       }
     }
  
     _rest._pdsch.SetData(pdsch_data());
     _rest._ce_values    = std::move(ce_values());
  
     // Decode PDSCH..
     auto ret = srsran_ue_dl_decode_pdsch(&_ue_dl, &_sf_cfg, &_ue_dl_cfg.cfg.pdsch, pdsch_res);
     if (ret) {
       spdlog::error("Error decoding PDSCH\n");
       _rest._pdsch.errors++;
     } else {
       spdlog::debug("Decoded PDSCH");
       _rest._pdsch.evm_rms = pdsch_res[0].evm; // evm of the first codeword
       for (int i = 0; i < SRSRAN_MAX_CODEWORDS; i++) {
         // .. and pass received PDUs to RLC for further processing
         if (pdsch_cfg->grant.tb[i].enabled && pdsch_res[i].crc) {
           _rlc.write_pdu_bcch_dlsch(_data[i], (uint32_t)pdsch_cfg->grant.tb[i].tbs);
         }
       }
     }
   }
     _mutex.unlock();
   return true;
 }

◆ rx_buffer_size()

uint32_t CasFrameProcessor::rx_buffer_size ( )

inline

Size of the signal buffer.

Definition at line 89 of file CasFrameProcessor.h.

89 { return _signal_buffer_max_samples; }

◆ set_cell()

void CasFrameProcessor::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 84 of file CasFrameProcessor.cpp.

                                                    {
   _cell = cell;
   spdlog::debug("CAS processor setting cell ({} PRB / {} MBSFN PRB).", cell.nof_prb, cell.mbsfn_prb);
   srsran_ue_dl_set_cell(&_ue_dl, cell);
   _started = true;
 }

◆ set_cfo_estimate()

void CasFrameProcessor::set_cfo_estimate ( bool enable )

inline

Enables the estimation of the carrier frequency offset.

Definition at line 160 of file CasFrameProcessor.h.

160 { _ue_dl_cfg.chest_cfg.cfo_estimate_enable = enable; };

◆ set_estimator_alg()

void CasFrameProcessor::set_estimator_alg ( srsran_chest_dl_estimator_alg_t estimator_alg )

inline

Set the method to estimate the channel estimates of the complete resource grid from the reference symbols.

Definition at line 154 of file CasFrameProcessor.h.

154 { _ue_dl_cfg.chest_cfg.estimator_alg = estimator_alg; };

◆ set_evm_meas()

void CasFrameProcessor::set_evm_meas ( bool enable )

inline

Enables the computation of the error vector magnitude on the PDSCH.

Definition at line 166 of file CasFrameProcessor.h.

166 { _ue_dl_cfg.cfg.pdsch.meas_evm_en = enable; };

◆ set_filter_coef()

void CasFrameProcessor::set_filter_coef ( float filter_coef )

inline

Set the coef for gauss filtering.

Definition at line 130 of file CasFrameProcessor.h.

130 { _ue_dl_cfg.chest_cfg.filter_coef[1] = filter_coef; };

◆ set_filter_order()

void CasFrameProcessor::set_filter_order ( uint8_t filter_order )

inline

Set the filter order used to filter the channel estimates.

Definition at line 124 of file CasFrameProcessor.h.

124 { _ue_dl_cfg.chest_cfg.filter_coef[0]= filter_order; };

◆ set_filter_type()

void CasFrameProcessor::set_filter_type ( srsran_chest_filter_t filter_type )

inline

Set the filter type for chest.

Definition at line 136 of file CasFrameProcessor.h.

136 { _ue_dl_cfg.chest_cfg.filter_type = filter_type; };

◆ set_noise_alg()

void CasFrameProcessor::set_noise_alg ( srsran_chest_dl_noise_alg_t noise_alg )

inline

Set the noise estimation algorithm used in the channel estimation stage.

Definition at line 142 of file CasFrameProcessor.h.

142 { _ue_dl_cfg.chest_cfg.noise_alg = noise_alg; };

◆ set_sync_error()

void CasFrameProcessor::set_sync_error ( bool enable )

inline

Enables the estimation os synchronization error.

Definition at line 148 of file CasFrameProcessor.h.

148 { _ue_dl_cfg.chest_cfg.sync_error_enable = enable; };

◆ unlock()

void CasFrameProcessor::unlock ( )

inline

Unlock the processor.

See also: get_rx_buffer_and_lock()

Definition at line 96 of file CasFrameProcessor.h.

96 { _mutex.unlock(); }

Member Data Documentation

◆ _cell

srsran_cell_t CasFrameProcessor::_cell

private

Definition at line 190 of file CasFrameProcessor.h.

◆ _cfg

const libconfig::Config& CasFrameProcessor::_cfg

private

Definition at line 175 of file CasFrameProcessor.h.

◆ _data

uint8_t* CasFrameProcessor::_data[SRSRAN_MAX_CODEWORDS]

private

Definition at line 184 of file CasFrameProcessor.h.

◆ _mutex

std::mutex CasFrameProcessor::_mutex

private

Definition at line 191 of file CasFrameProcessor.h.

◆ _phy

Phy& CasFrameProcessor::_phy

private

Definition at line 177 of file CasFrameProcessor.h.

◆ _rest

RestHandler& CasFrameProcessor::_rest

private

Definition at line 178 of file CasFrameProcessor.h.

◆ _rlc

srsran::rlc& CasFrameProcessor::_rlc

private

Definition at line 176 of file CasFrameProcessor.h.

◆ _rx_channels

unsigned CasFrameProcessor::_rx_channels

private

Definition at line 192 of file CasFrameProcessor.h.

◆ _sf_cfg

srsran_dl_sf_cfg_t CasFrameProcessor::_sf_cfg = {}

private

Definition at line 188 of file CasFrameProcessor.h.

◆ _signal_buffer_max_samples

uint32_t CasFrameProcessor::_signal_buffer_max_samples = 0

private

Definition at line 181 of file CasFrameProcessor.h.

◆ _signal_buffer_rx

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

private

Definition at line 180 of file CasFrameProcessor.h.

◆ _softbuffer

srsran_softbuffer_rx_t CasFrameProcessor::_softbuffer

private

Definition at line 183 of file CasFrameProcessor.h.

◆ _started

bool CasFrameProcessor::_started = 0

private

Definition at line 194 of file CasFrameProcessor.h.

◆ _ue_dl

srsran_ue_dl_t CasFrameProcessor::_ue_dl = {}

private

Definition at line 186 of file CasFrameProcessor.h.

◆ _ue_dl_cfg

srsran_ue_dl_cfg_t CasFrameProcessor::_ue_dl_cfg = {}

private

Definition at line 187 of file CasFrameProcessor.h.

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

src/CasFrameProcessor.h
src/CasFrameProcessor.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CasFrameProcessor()

◆ ~CasFrameProcessor()

Member Function Documentation

◆ ce_values()

◆ cinr_db()

◆ get_cfo_estimate()

◆ get_estimator_alg()

◆ get_evm_meas()

◆ get_filter_coef()

◆ get_filter_order()

◆ get_filter_type()

◆ get_noise_alg()

◆ get_rx_buffer_and_lock()

◆ get_sync_error()

◆ init()

◆ is_started()

◆ lock()

◆ pdsch_data()

◆ process()

◆ rx_buffer_size()

◆ set_cell()

◆ set_cfo_estimate()

◆ set_estimator_alg()

◆ set_evm_meas()

◆ set_filter_coef()

◆ set_filter_order()

◆ set_filter_type()

◆ set_noise_alg()

◆ set_sync_error()

◆ unlock()

Member Data Documentation

◆ _cell

◆ _cfg

◆ _data

◆ _mutex

◆ _phy

◆ _rest

◆ _rlc

◆ _rx_channels

◆ _sf_cfg

◆ _signal_buffer_max_samples

◆ _signal_buffer_rx

◆ _softbuffer

◆ _started

◆ _ue_dl

◆ _ue_dl_cfg