2018-08-01 13:55:40 +00:00
/*!
2019-02-26 18:30:08 +00:00
* \ file galileo_e5a_dll_pll_tracking_fpga . cc
2018-08-01 13:55:40 +00:00
* \ brief Adapts a code DLL + carrier PLL
2019-02-26 18:30:08 +00:00
* tracking block to a TrackingInterface for Galileo E5a signals for the FPGA
2019-03-01 09:11:36 +00:00
* \ author Marc Majoral , 2019. mmajoral ( at ) cttc . cat
2018-08-01 13:55:40 +00:00
*
2020-07-28 14:57:15 +00:00
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2018-08-01 13:55:40 +00:00
*
2020-12-30 12:35:06 +00:00
* GNSS - SDR is a Global Navigation Satellite System software - defined receiver .
2018-08-01 13:55:40 +00:00
* This file is part of GNSS - SDR .
*
2020-12-30 12:35:06 +00:00
* Copyright ( C ) 2010 - 2020 ( see AUTHORS file for a list of contributors )
2020-02-08 00:20:02 +00:00
* SPDX - License - Identifier : GPL - 3.0 - or - later
2018-08-01 13:55:40 +00:00
*
2020-07-28 14:57:15 +00:00
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2018-08-01 13:55:40 +00:00
*/
# include "galileo_e5a_dll_pll_tracking_fpga.h"
# include "Galileo_E5a.h"
2018-12-09 21:00:09 +00:00
# include "configuration_interface.h"
# include "display.h"
2019-03-06 13:36:51 +00:00
# include "dll_pll_conf_fpga.h"
2020-11-07 21:43:19 +00:00
# include "galileo_e5_signal_replica.h"
2018-08-01 13:55:40 +00:00
# include "gnss_sdr_flags.h"
2020-11-27 09:51:06 +00:00
# include "uio_fpga.h"
2018-08-01 13:55:40 +00:00
# include <glog/logging.h>
2019-10-27 20:34:19 +00:00
# include <volk_gnsssdr/volk_gnsssdr_alloc.h>
2019-07-14 12:09:12 +00:00
# include <array>
2018-08-01 13:55:40 +00:00
GalileoE5aDllPllTrackingFpga : : GalileoE5aDllPllTrackingFpga (
2020-06-29 07:07:41 +00:00
const ConfigurationInterface * configuration , const std : : string & role ,
2018-08-01 13:55:40 +00:00
unsigned int in_streams , unsigned int out_streams ) : role_ ( role ) , in_streams_ ( in_streams ) , out_streams_ ( out_streams )
{
2020-02-19 23:07:03 +00:00
Dll_Pll_Conf_Fpga trk_params_fpga = Dll_Pll_Conf_Fpga ( ) ;
2018-08-01 13:55:40 +00:00
DLOG ( INFO ) < < " role " < < role ;
2020-02-19 23:07:03 +00:00
trk_params_fpga . SetFromConfiguration ( configuration , role ) ;
2019-03-28 11:30:57 +00:00
2020-07-17 08:48:37 +00:00
const auto vector_length = static_cast < int32_t > ( std : : round ( trk_params_fpga . fs_in / ( GALILEO_E5A_CODE_CHIP_RATE_CPS / GALILEO_E5A_CODE_LENGTH_CHIPS ) ) ) ;
2020-02-19 23:07:03 +00:00
trk_params_fpga . vector_length = vector_length ;
d_track_pilot = trk_params_fpga . track_pilot ;
if ( trk_params_fpga . extend_correlation_symbols < 1 )
2019-03-28 11:30:57 +00:00
{
2020-02-19 23:07:03 +00:00
trk_params_fpga . extend_correlation_symbols = 1 ;
2020-07-07 16:53:50 +00:00
std : : cout < < TEXT_RED < < " WARNING: Galileo E5a. extend_correlation_symbols must be bigger than 0. Coherent integration has been set to 1 symbol (1 ms) " < < TEXT_RESET < < ' \n ' ;
2018-08-01 13:55:40 +00:00
}
2020-02-19 23:07:03 +00:00
else if ( ! trk_params_fpga . track_pilot and trk_params_fpga . extend_correlation_symbols > GALILEO_E5A_I_SECONDARY_CODE_LENGTH )
2018-08-01 13:55:40 +00:00
{
2020-02-19 23:07:03 +00:00
trk_params_fpga . extend_correlation_symbols = GALILEO_E5A_I_SECONDARY_CODE_LENGTH ;
2020-07-07 16:53:50 +00:00
std : : cout < < TEXT_RED < < " WARNING: Galileo E5a. extend_correlation_symbols must be lower than 21 when tracking the data component. Coherent integration has been set to 20 symbols (20 ms) " < < TEXT_RESET < < ' \n ' ;
2018-08-01 13:55:40 +00:00
}
2020-02-19 23:07:03 +00:00
if ( ( trk_params_fpga . extend_correlation_symbols > 1 ) and ( trk_params_fpga . pll_bw_narrow_hz > trk_params_fpga . pll_bw_hz or trk_params_fpga . dll_bw_narrow_hz > trk_params_fpga . dll_bw_hz ) )
2018-08-01 13:55:40 +00:00
{
2020-07-07 16:53:50 +00:00
std : : cout < < TEXT_RED < < " WARNING: Galileo E5a. PLL or DLL narrow tracking bandwidth is higher than wide tracking one " < < TEXT_RESET < < ' \n ' ;
2018-08-01 13:55:40 +00:00
}
2020-02-19 23:07:03 +00:00
trk_params_fpga . system = ' E ' ;
2020-07-17 08:48:37 +00:00
const std : : array < char , 3 > sig_ { ' 5 ' , ' X ' , ' \0 ' } ;
2020-02-19 23:07:03 +00:00
std : : memcpy ( trk_params_fpga . signal , sig_ . data ( ) , 3 ) ;
2019-09-16 15:29:18 +00:00
2019-03-01 14:29:43 +00:00
d_data_codes = nullptr ;
2018-08-01 13:55:40 +00:00
2020-11-27 09:51:06 +00:00
// UIO device file
2021-02-10 17:43:11 +00:00
device_name = configuration - > property ( role + " .devicename " , default_device_name_Galileo_E5a ) ;
2020-11-27 09:51:06 +00:00
2019-10-02 13:53:57 +00:00
// compute the number of tracking channels that have already been instantiated. The order in which
// GNSS-SDR instantiates the tracking channels i L1, L2, L5, E1, E5a
2019-10-24 16:26:45 +00:00
// However E5a can use the same tracking HW accelerators as L5 (but not simultaneously).
// Therefore for the proper assignment of the FPGA tracking device file numbers to the E5a tracking channels,
// the number of channels that have already been assigned to L5 must not be substracted to this channel number,
// so they are not counted here.
2021-02-10 17:43:11 +00:00
uint32_t num_prev_assigned_ch_1C = configuration - > property ( " Channels_1C.count " , 0 ) ;
uint32_t num_prev_assigned_ch_2S = 0 ;
if ( configuration - > property ( " Tracking_2S.devicename " , std : : string ( " " ) ) ! = device_name )
{
num_prev_assigned_ch_2S = configuration - > property ( " Channels_2S.count " , 0 ) ;
}
uint32_t num_prev_assigned_ch_1B = configuration - > property ( " Channels_1B.count " , 0 ) ;
num_prev_assigned_ch = num_prev_assigned_ch_1C + num_prev_assigned_ch_2S + num_prev_assigned_ch_1B ;
2018-08-01 13:55:40 +00:00
2019-07-28 10:01:11 +00:00
// ################# PRE-COMPUTE ALL THE CODES #################
2019-02-27 13:37:07 +00:00
uint32_t code_samples_per_chip = 1 ;
auto code_length_chips = static_cast < uint32_t > ( GALILEO_E5A_CODE_LENGTH_CHIPS ) ;
2018-08-01 13:55:40 +00:00
2019-10-27 20:34:19 +00:00
volk_gnsssdr : : vector < gr_complex > aux_code ( code_length_chips * code_samples_per_chip , gr_complex ( 0.0 , 0.0 ) ) ;
2018-08-01 13:55:40 +00:00
2019-02-27 13:37:07 +00:00
d_ca_codes = static_cast < int32_t * > ( volk_gnsssdr_malloc ( static_cast < int32_t > ( code_length_chips ) * code_samples_per_chip * GALILEO_E5A_NUMBER_OF_CODES * sizeof ( int32_t ) , volk_gnsssdr_get_alignment ( ) ) ) ;
2018-08-01 13:55:40 +00:00
2020-02-19 23:07:03 +00:00
if ( trk_params_fpga . track_pilot )
2018-08-01 13:55:40 +00:00
{
2019-02-27 13:37:07 +00:00
d_data_codes = static_cast < int32_t * > ( volk_gnsssdr_malloc ( ( static_cast < uint32_t > ( code_length_chips ) ) * code_samples_per_chip * GALILEO_E5A_NUMBER_OF_CODES * sizeof ( int32_t ) , volk_gnsssdr_get_alignment ( ) ) ) ;
2018-08-01 13:55:40 +00:00
}
2019-02-27 13:37:07 +00:00
for ( uint32_t PRN = 1 ; PRN < = GALILEO_E5A_NUMBER_OF_CODES ; PRN + + )
2018-08-01 13:55:40 +00:00
{
2020-07-17 08:48:37 +00:00
const std : : array < char , 3 > sig_a = { ' 5 ' , ' X ' , ' \0 ' } ;
2019-10-27 20:34:19 +00:00
galileo_e5_a_code_gen_complex_primary ( aux_code , PRN , sig_a ) ;
2019-04-02 16:46:37 +00:00
2020-02-19 23:07:03 +00:00
if ( trk_params_fpga . track_pilot )
2018-10-28 10:07:53 +00:00
{
2019-04-02 16:46:37 +00:00
// The code is generated as a series of 1s and -1s. In order to store the values using only one bit, a -1 is stored as a 0 in the FPGA
2019-02-27 13:37:07 +00:00
for ( uint32_t s = 0 ; s < code_length_chips ; s + + )
2018-10-28 10:07:53 +00:00
{
2019-06-30 10:09:11 +00:00
auto tmp_value = static_cast < int32_t > ( aux_code [ s ] . imag ( ) ) ;
2019-04-02 16:46:37 +00:00
if ( tmp_value < 0 )
{
tmp_value = 0 ;
}
2019-04-02 18:36:48 +00:00
tmp_value = tmp_value | LOCAL_CODE_FPGA_ENABLE_WRITE_MEMORY ;
2019-04-02 16:46:37 +00:00
d_ca_codes [ static_cast < int32_t > ( code_length_chips ) * ( PRN - 1 ) + s ] = tmp_value ;
tmp_value = static_cast < int32_t > ( aux_code [ s ] . real ( ) ) ;
if ( tmp_value < 0 )
{
tmp_value = 0 ;
}
2019-04-02 18:36:48 +00:00
tmp_value = tmp_value | LOCAL_CODE_FPGA_ENABLE_WRITE_MEMORY | LOCAL_CODE_FPGA_CORRELATOR_SELECT_COUNT ;
2019-04-02 16:46:37 +00:00
d_data_codes [ static_cast < int32_t > ( code_length_chips ) * ( PRN - 1 ) + s ] = tmp_value ;
2018-10-28 10:07:53 +00:00
}
}
else
{
2019-04-02 16:46:37 +00:00
// The code is generated as a series of 1s and -1s. In order to store the values using only one bit, a -1 is stored as a 0 in the FPGA
2019-02-27 13:37:07 +00:00
for ( uint32_t s = 0 ; s < code_length_chips ; s + + )
2018-10-28 10:07:53 +00:00
{
2019-06-30 10:09:11 +00:00
auto tmp_value = static_cast < int32_t > ( aux_code [ s ] . real ( ) ) ;
2019-04-02 16:46:37 +00:00
if ( tmp_value < 0 )
{
tmp_value = 0 ;
}
2019-04-02 18:36:48 +00:00
tmp_value = tmp_value | LOCAL_CODE_FPGA_ENABLE_WRITE_MEMORY ;
2019-04-02 16:46:37 +00:00
d_ca_codes [ static_cast < int32_t > ( code_length_chips ) * ( PRN - 1 ) + s ] = tmp_value ;
2018-10-28 10:07:53 +00:00
}
}
2018-08-01 13:55:40 +00:00
}
2020-02-19 23:07:03 +00:00
trk_params_fpga . ca_codes = d_ca_codes ;
trk_params_fpga . data_codes = d_data_codes ;
trk_params_fpga . code_length_chips = code_length_chips ;
trk_params_fpga . code_samples_per_chip = code_samples_per_chip ; // 2 sample per chip
2019-06-28 08:54:19 +00:00
2020-02-19 23:07:03 +00:00
trk_params_fpga . extended_correlation_in_fpga = false ; // by default
trk_params_fpga . extend_fpga_integration_periods = 1 ; // (number of FPGA integrations that are combined in the SW)
trk_params_fpga . fpga_integration_period = 1 ; // (number of symbols that are effectively integrated in the FPGA)
2019-06-18 16:22:01 +00:00
if ( d_track_pilot )
2019-07-19 09:55:53 +00:00
{
2020-02-19 23:07:03 +00:00
if ( trk_params_fpga . extend_correlation_symbols > 1 )
2019-07-19 09:55:53 +00:00
{
2020-02-19 23:07:03 +00:00
if ( trk_params_fpga . extend_correlation_symbols < = GALILEO_E5A_I_SECONDARY_CODE_LENGTH )
2019-07-19 09:55:53 +00:00
{
2020-02-19 23:07:03 +00:00
if ( ( GALILEO_E5A_I_SECONDARY_CODE_LENGTH % trk_params_fpga . extend_correlation_symbols ) = = 0 )
2019-07-19 09:55:53 +00:00
{
2020-02-19 23:07:03 +00:00
trk_params_fpga . extended_correlation_in_fpga = true ;
trk_params_fpga . fpga_integration_period = trk_params_fpga . extend_correlation_symbols ;
2019-07-19 09:55:53 +00:00
}
}
else
{
2020-02-19 23:07:03 +00:00
if ( trk_params_fpga . extend_correlation_symbols % GALILEO_E5A_I_SECONDARY_CODE_LENGTH = = 0 )
2019-07-19 09:55:53 +00:00
{
2020-02-19 23:07:03 +00:00
trk_params_fpga . extended_correlation_in_fpga = true ;
trk_params_fpga . extend_fpga_integration_periods = trk_params_fpga . extend_correlation_symbols / GALILEO_E5A_I_SECONDARY_CODE_LENGTH ;
trk_params_fpga . fpga_integration_period = GALILEO_E5A_I_SECONDARY_CODE_LENGTH ;
2019-07-19 09:55:53 +00:00
}
}
}
}
2019-06-28 08:54:19 +00:00
2019-07-28 10:01:11 +00:00
// ################# MAKE TRACKING GNURadio object ###################
2020-02-19 23:07:03 +00:00
tracking_fpga_sc = dll_pll_veml_make_tracking_fpga ( trk_params_fpga ) ;
2018-08-01 13:55:40 +00:00
channel_ = 0 ;
2018-08-07 16:56:54 +00:00
2018-08-01 13:55:40 +00:00
DLOG ( INFO ) < < " tracking( " < < tracking_fpga_sc - > unique_id ( ) < < " ) " ;
2019-08-13 19:26:36 +00:00
if ( in_streams_ > 1 )
{
LOG ( ERROR ) < < " This implementation only supports one input stream " ;
}
if ( out_streams_ > 1 )
{
LOG ( ERROR ) < < " This implementation only supports one output stream " ;
}
2018-08-01 13:55:40 +00:00
}
GalileoE5aDllPllTrackingFpga : : ~ GalileoE5aDllPllTrackingFpga ( )
{
2019-07-01 09:03:18 +00:00
volk_gnsssdr_free ( d_ca_codes ) ;
2018-08-01 13:55:40 +00:00
if ( d_track_pilot )
{
2019-07-01 09:03:18 +00:00
volk_gnsssdr_free ( d_data_codes ) ;
2018-08-01 13:55:40 +00:00
}
}
void GalileoE5aDllPllTrackingFpga : : start_tracking ( )
{
tracking_fpga_sc - > start_tracking ( ) ;
}
2019-03-01 19:49:45 +00:00
void GalileoE5aDllPllTrackingFpga : : stop_tracking ( )
{
2019-07-18 17:12:17 +00:00
tracking_fpga_sc - > stop_tracking ( ) ;
2019-03-01 19:49:45 +00:00
}
2018-08-01 13:55:40 +00:00
/*
* Set tracking channel unique ID
*/
void GalileoE5aDllPllTrackingFpga : : set_channel ( unsigned int channel )
{
channel_ = channel ;
2020-11-27 09:51:06 +00:00
// UIO device file
std : : string device_io_name ;
2020-11-27 11:21:10 +00:00
// find the uio device file corresponding to the tracking multicorrelator
2020-11-27 09:51:06 +00:00
if ( find_uio_dev_file_name ( device_io_name , device_name , channel - num_prev_assigned_ch ) < 0 )
{
std : : cout < < " Cannot find the FPGA uio device file corresponding to device name " < < device_name < < std : : endl ;
throw std : : exception ( ) ;
}
tracking_fpga_sc - > set_channel ( channel , device_io_name ) ;
2018-08-01 13:55:40 +00:00
}
2018-10-28 10:07:53 +00:00
void GalileoE5aDllPllTrackingFpga : : set_gnss_synchro ( Gnss_Synchro * p_gnss_synchro )
2018-08-01 13:55:40 +00:00
{
tracking_fpga_sc - > set_gnss_synchro ( p_gnss_synchro ) ;
}
void GalileoE5aDllPllTrackingFpga : : connect ( gr : : top_block_sptr top_block )
{
if ( top_block )
{ /* top_block is not null */
} ;
2019-07-28 10:01:11 +00:00
// nothing to connect, now the tracking uses gr_sync_decimator
2018-08-01 13:55:40 +00:00
}
void GalileoE5aDllPllTrackingFpga : : disconnect ( gr : : top_block_sptr top_block )
{
if ( top_block )
{ /* top_block is not null */
} ;
2019-07-28 10:01:11 +00:00
// nothing to disconnect, now the tracking uses gr_sync_decimator
2018-08-01 13:55:40 +00:00
}
gr : : basic_block_sptr GalileoE5aDllPllTrackingFpga : : get_left_block ( )
{
return tracking_fpga_sc ;
}
gr : : basic_block_sptr GalileoE5aDllPllTrackingFpga : : get_right_block ( )
{
return tracking_fpga_sc ;
}