2014-08-20 08:59:47 +00:00
/*!
2016-04-08 16:25:50 +00:00
* \ file galileo_e5a_dll_pll_tracking . cc
2014-08-20 08:59:47 +00:00
* \ brief Adapts a code DLL + carrier PLL
* tracking block to a TrackingInterface for Galileo E5a signals
* \ author Marc Sales , 2014. marcsales92 ( at ) gmail . com
* \ based on work from :
2016-05-02 21:46:30 +00:00
* < ul >
2014-08-20 08:59:47 +00:00
* < li > Javier Arribas , 2011. jarribas ( at ) cttc . es
* < li > Luis Esteve , 2012. luis ( at ) epsilon - formacion . com
* < / ul >
2014-06-20 16:23:44 +00:00
*
2014-08-20 08:59:47 +00:00
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*
2019-07-26 10:38:20 +00:00
* Copyright ( C ) 2010 - 2019 ( see AUTHORS file for a list of contributors )
2014-08-20 08:59:47 +00:00
*
* GNSS - SDR is a software defined Global Navigation
* Satellite Systems receiver
*
* This file is part of GNSS - SDR .
*
* GNSS - SDR is free software : you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation , either version 3 of the License , or
2015-01-08 18:49:59 +00:00
* ( at your option ) any later version .
2014-08-20 08:59:47 +00:00
*
* GNSS - SDR 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
2018-05-13 20:49:11 +00:00
* along with GNSS - SDR . If not , see < https : //www.gnu.org/licenses/>.
2014-08-20 08:59:47 +00:00
*
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
2014-06-20 16:23:44 +00:00
*/
# include "galileo_e5a_dll_pll_tracking.h"
2018-02-26 02:15:53 +00:00
# include "Galileo_E5a.h"
2018-12-09 21:00:09 +00:00
# include "configuration_interface.h"
2018-03-20 09:33:02 +00:00
# include "display.h"
2018-12-09 21:00:09 +00:00
# include "dll_pll_conf.h"
# include "gnss_sdr_flags.h"
2018-02-26 02:15:53 +00:00
# include <glog/logging.h>
2019-07-14 12:09:12 +00:00
# include <array>
2018-10-28 10:07:53 +00:00
2014-06-20 16:23:44 +00:00
GalileoE5aDllPllTracking : : GalileoE5aDllPllTracking (
2018-12-03 18:01:47 +00:00
ConfigurationInterface * configuration , const std : : string & role ,
2018-03-03 01:03:39 +00:00
unsigned int in_streams , unsigned int out_streams ) : role_ ( role ) , in_streams_ ( in_streams ) , out_streams_ ( out_streams )
2014-06-20 16:23:44 +00:00
{
2018-06-19 10:55:14 +00:00
Dll_Pll_Conf trk_param = Dll_Pll_Conf ( ) ;
2014-06-20 16:23:44 +00:00
DLOG ( INFO ) < < " role " < < role ;
2019-07-28 10:01:11 +00:00
// ################# CONFIGURATION PARAMETERS ########################
2014-06-20 16:23:44 +00:00
std : : string default_item_type = " gr_complex " ;
2018-03-20 09:33:02 +00:00
std : : string item_type = configuration - > property ( role + " .item_type " , default_item_type ) ;
2017-09-02 09:24:44 +00:00
int fs_in_deprecated = configuration - > property ( " GNSS-SDR.internal_fs_hz " , 12000000 ) ;
2018-03-20 09:33:02 +00:00
int fs_in = configuration - > property ( " GNSS-SDR.internal_fs_sps " , fs_in_deprecated ) ;
2018-04-06 08:10:32 +00:00
trk_param . fs_in = fs_in ;
2018-03-20 09:33:02 +00:00
bool dump = configuration - > property ( role + " .dump " , false ) ;
2018-04-06 08:10:32 +00:00
trk_param . dump = dump ;
2018-10-29 23:47:12 +00:00
std : : string default_dump_filename = " ./track_ch " ;
std : : string dump_filename = configuration - > property ( role + " .dump_filename " , default_dump_filename ) ;
trk_param . dump_filename = dump_filename ;
bool dump_mat = configuration - > property ( role + " .dump_mat " , true ) ;
trk_param . dump_mat = dump_mat ;
2018-09-17 17:39:59 +00:00
trk_param . high_dyn = configuration - > property ( role + " .high_dyn " , false ) ;
if ( configuration - > property ( role + " .smoother_length " , 10 ) < 1 )
{
trk_param . smoother_length = 1 ;
std : : cout < < TEXT_RED < < " WARNING: Gal. E5a. smoother_length must be bigger than 0. It has been set to 1 " < < TEXT_RESET < < std : : endl ;
}
else
{
trk_param . smoother_length = configuration - > property ( role + " .smoother_length " , 10 ) ;
}
2018-03-20 09:33:02 +00:00
float pll_bw_hz = configuration - > property ( role + " .pll_bw_hz " , 20.0 ) ;
2019-02-11 20:13:02 +00:00
if ( FLAGS_pll_bw_hz ! = 0.0 )
{
pll_bw_hz = static_cast < float > ( FLAGS_pll_bw_hz ) ;
}
2018-04-06 08:10:32 +00:00
trk_param . pll_bw_hz = pll_bw_hz ;
2018-03-20 09:33:02 +00:00
float dll_bw_hz = configuration - > property ( role + " .dll_bw_hz " , 20.0 ) ;
2019-02-11 20:13:02 +00:00
if ( FLAGS_dll_bw_hz ! = 0.0 )
{
dll_bw_hz = static_cast < float > ( FLAGS_dll_bw_hz ) ;
}
2018-04-06 08:10:32 +00:00
trk_param . dll_bw_hz = dll_bw_hz ;
2019-03-21 18:21:39 +00:00
int dll_filter_order = configuration - > property ( role + " .dll_filter_order " , 2 ) ;
if ( dll_filter_order < 1 )
{
LOG ( WARNING ) < < " dll_filter_order parameter must be 1, 2 or 3. Set to 1. " ;
dll_filter_order = 1 ;
}
if ( dll_filter_order > 3 )
{
LOG ( WARNING ) < < " dll_filter_order parameter must be 1, 2 or 3. Set to 3. " ;
dll_filter_order = 3 ;
}
trk_param . dll_filter_order = dll_filter_order ;
int pll_filter_order = configuration - > property ( role + " .pll_filter_order " , 3 ) ;
if ( pll_filter_order < 2 )
{
LOG ( WARNING ) < < " pll_filter_order parameter must be 2 or 3. Set to 2. " ;
pll_filter_order = 2 ;
}
if ( pll_filter_order > 3 )
{
LOG ( WARNING ) < < " pll_filter_order parameter must be 2 or 3. Set to 3. " ;
pll_filter_order = 3 ;
}
trk_param . pll_filter_order = pll_filter_order ;
if ( pll_filter_order = = 2 )
{
trk_param . fll_filter_order = 1 ;
}
if ( pll_filter_order = = 3 )
{
trk_param . fll_filter_order = 2 ;
}
bool enable_fll_pull_in = configuration - > property ( role + " .enable_fll_pull_in " , false ) ;
trk_param . enable_fll_pull_in = enable_fll_pull_in ;
2019-08-28 10:42:55 +00:00
bool enable_fll_steady_state = configuration - > property ( role + " .enable_fll_steady_state " , false ) ;
trk_param . enable_fll_steady_state = enable_fll_steady_state ;
2019-03-21 18:21:39 +00:00
float fll_bw_hz = configuration - > property ( role + " .fll_bw_hz " , 35.0 ) ;
trk_param . fll_bw_hz = fll_bw_hz ;
2019-06-14 10:52:46 +00:00
trk_param . pull_in_time_s = configuration - > property ( role + " .pull_in_time_s " , trk_param . pull_in_time_s ) ;
2019-03-21 18:21:39 +00:00
2018-03-20 09:33:02 +00:00
float pll_bw_narrow_hz = configuration - > property ( role + " .pll_bw_narrow_hz " , 5.0 ) ;
2018-04-06 08:10:32 +00:00
trk_param . pll_bw_narrow_hz = pll_bw_narrow_hz ;
2018-03-20 09:33:02 +00:00
float dll_bw_narrow_hz = configuration - > property ( role + " .dll_bw_narrow_hz " , 2.0 ) ;
2018-04-06 08:10:32 +00:00
trk_param . dll_bw_narrow_hz = dll_bw_narrow_hz ;
2018-03-20 09:33:02 +00:00
float early_late_space_chips = configuration - > property ( role + " .early_late_space_chips " , 0.5 ) ;
2018-04-06 08:10:32 +00:00
trk_param . early_late_space_chips = early_late_space_chips ;
2019-02-22 09:47:24 +00:00
int vector_length = std : : round ( fs_in / ( GALILEO_E5A_CODE_CHIP_RATE_HZ / GALILEO_E5A_CODE_LENGTH_CHIPS ) ) ;
2018-04-06 08:10:32 +00:00
trk_param . vector_length = vector_length ;
2018-03-20 09:33:02 +00:00
int extend_correlation_symbols = configuration - > property ( role + " .extend_correlation_symbols " , 1 ) ;
2019-06-14 10:52:46 +00:00
float early_late_space_narrow_chips = configuration - > property ( role + " .early_late_space_narrow_chips " , 0.5 ) ;
2018-04-06 08:10:32 +00:00
trk_param . early_late_space_narrow_chips = early_late_space_narrow_chips ;
2018-03-20 09:33:02 +00:00
bool track_pilot = configuration - > property ( role + " .track_pilot " , false ) ;
if ( extend_correlation_symbols < 1 )
{
extend_correlation_symbols = 1 ;
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 < < std : : endl ;
}
2019-02-22 09:47:24 +00:00
else if ( ! track_pilot and extend_correlation_symbols > GALILEO_E5A_I_SECONDARY_CODE_LENGTH )
2018-03-20 09:33:02 +00:00
{
2019-02-22 09:47:24 +00:00
extend_correlation_symbols = GALILEO_E5A_I_SECONDARY_CODE_LENGTH ;
2018-03-20 09:33:02 +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 < < std : : endl ;
}
2018-03-20 16:24:16 +00:00
if ( ( extend_correlation_symbols > 1 ) and ( pll_bw_narrow_hz > pll_bw_hz or dll_bw_narrow_hz > dll_bw_hz ) )
2018-03-20 11:30:20 +00:00
{
std : : cout < < TEXT_RED < < " WARNING: Galileo E5a. PLL or DLL narrow tracking bandwidth is higher than wide tracking one " < < TEXT_RESET < < std : : endl ;
}
2018-04-06 08:10:32 +00:00
trk_param . extend_correlation_symbols = extend_correlation_symbols ;
trk_param . track_pilot = track_pilot ;
trk_param . very_early_late_space_chips = 0.0 ;
trk_param . very_early_late_space_narrow_chips = 0.0 ;
trk_param . system = ' E ' ;
2019-07-14 12:09:12 +00:00
std : : array < char , 3 > sig_ { ' 5 ' , ' X ' , ' \0 ' } ;
std : : memcpy ( trk_param . signal , sig_ . data ( ) , 3 ) ;
2019-06-11 18:20:23 +00:00
trk_param . cn0_samples = configuration - > property ( role + " .cn0_samples " , trk_param . cn0_samples ) ;
trk_param . cn0_min = configuration - > property ( role + " .cn0_min " , trk_param . cn0_min ) ;
trk_param . max_code_lock_fail = configuration - > property ( role + " .max_lock_fail " , trk_param . max_code_lock_fail ) ;
trk_param . max_carrier_lock_fail = configuration - > property ( role + " .max_carrier_lock_fail " , trk_param . max_carrier_lock_fail ) ;
trk_param . carrier_lock_th = configuration - > property ( role + " .carrier_lock_th " , trk_param . carrier_lock_th ) ;
2018-04-28 10:33:46 +00:00
2019-07-28 10:01:11 +00:00
// ################# MAKE TRACKING GNURadio object ###################
2018-12-03 11:52:17 +00:00
if ( item_type = = " gr_complex " )
2014-06-20 16:23:44 +00:00
{
item_size_ = sizeof ( gr_complex ) ;
2018-04-06 08:10:32 +00:00
tracking_ = dll_pll_veml_make_tracking ( trk_param ) ;
2014-06-20 16:23:44 +00:00
}
else
{
2015-05-17 09:02:27 +00:00
item_size_ = sizeof ( gr_complex ) ;
2014-06-20 16:23:44 +00:00
LOG ( WARNING ) < < item_type < < " unknown tracking item type. " ;
}
2015-05-17 09:02:27 +00:00
channel_ = 0 ;
2014-06-20 16:23:44 +00:00
DLOG ( INFO ) < < " tracking( " < < tracking_ - > unique_id ( ) < < " ) " ;
2018-06-03 17:11:16 +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 " ;
}
2014-06-20 16:23:44 +00:00
}
2018-12-03 10:12:10 +00:00
void GalileoE5aDllPllTracking : : stop_tracking ( )
2018-03-03 01:03:39 +00:00
{
2019-07-25 14:38:19 +00:00
tracking_ - > stop_tracking ( ) ;
2018-03-03 01:03:39 +00:00
}
2014-06-20 16:23:44 +00:00
void GalileoE5aDllPllTracking : : start_tracking ( )
{
2018-04-05 19:35:01 +00:00
tracking_ - > start_tracking ( ) ;
2014-06-20 16:23:44 +00:00
}
2018-04-05 19:35:01 +00:00
2014-06-20 16:23:44 +00:00
/*
* Set tracking channel unique ID
*/
void GalileoE5aDllPllTracking : : set_channel ( unsigned int channel )
{
channel_ = channel ;
2018-04-05 19:35:01 +00:00
tracking_ - > set_channel ( channel ) ;
2014-06-20 16:23:44 +00:00
}
void GalileoE5aDllPllTracking : : set_gnss_synchro ( Gnss_Synchro * p_gnss_synchro )
{
2018-04-05 19:35:01 +00:00
tracking_ - > set_gnss_synchro ( p_gnss_synchro ) ;
2014-06-20 16:23:44 +00:00
}
2018-04-05 19:35:01 +00:00
2014-06-20 16:23:44 +00:00
void GalileoE5aDllPllTracking : : connect ( gr : : top_block_sptr top_block )
{
2018-03-03 01:03:39 +00:00
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
2014-06-20 16:23:44 +00:00
}
2018-04-05 19:35:01 +00:00
2014-06-20 16:23:44 +00:00
void GalileoE5aDllPllTracking : : disconnect ( gr : : top_block_sptr top_block )
{
2018-03-03 01:03:39 +00:00
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
2014-06-20 16:23:44 +00:00
}
2018-04-05 19:35:01 +00:00
2014-06-20 16:23:44 +00:00
gr : : basic_block_sptr GalileoE5aDllPllTracking : : get_left_block ( )
{
2018-04-05 19:35:01 +00:00
return tracking_ ;
2014-06-20 16:23:44 +00:00
}
2018-04-05 19:35:01 +00:00
2014-06-20 16:23:44 +00:00
gr : : basic_block_sptr GalileoE5aDllPllTracking : : get_right_block ( )
{
2018-04-05 19:35:01 +00:00
return tracking_ ;
2014-06-20 16:23:44 +00:00
}