defs.h 11.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */
ghaddab's avatar
ghaddab committed
21

22 23 24 25 26 27 28 29
#ifndef __LTE_ESTIMATION_DEFS__H__
#define __LTE_ESTIMATION_DEFS__H__

#include "PHY/defs.h"
/*
#ifdef EMOS
#include "SCHED/phy_procedures_emos.h"
#endif
gauthier's avatar
gauthier committed
30
 */
31 32

/** @addtogroup _PHY_PARAMETER_ESTIMATION_BLOCKS_
gauthier's avatar
gauthier committed
33 34
 * @{
 */
35 36

/*!\brief Timing drift hysterisis in samples*/
37
#define SYNCH_HYST 2
38

39 40 41 42 43
/*!
\brief This function is used for time-frequency scanning prior to complete cell search.  It scans
over the entire LTE band for maximum correlation and keeps the 10 best scores and the correspoding frequency offset (5 kHz granularity) for each of the 3 PSS sequences.
\param ue Pointer to UE variables
\param band index of lte band
44
\param DL_freq Central RF Frequency in Hz
45
*/
46 47 48
/*!
\brief This function allocates memory needed for the synchronization.
\param frame_parms LTE DL frame parameter structure
49

gauthier's avatar
gauthier committed
50
 */
51 52 53 54 55

int lte_sync_time_init(LTE_DL_FRAME_PARMS *frame_parms); //LTE_UE_COMMON *common_vars

/*! \fn void lte_sync_time_free()
\brief This function frees the memory allocated by lte_sync_time_init.
gauthier's avatar
gauthier committed
56
 */
57 58
void lte_sync_time_free(void);

59
/*!
60
\brief This function performs the coarse timing synchronization.
61
The algorithm uses a time domain correlation with a downsampled version of the received signal.
62 63 64 65
\param rxdata Received time domain data for all rx antennas
\param frame_parms LTE DL frame parameter structure
\param eNB_id return value with the eNb_id
\return sync_pos Position of the sync within the frame (downsampled) if successfull and -1 if there was an error or no peak was detected.
gauthier's avatar
gauthier committed
66
 */
67 68 69
int lte_sync_time(int **rxdata,
                  LTE_DL_FRAME_PARMS *frame_parms,
                  int *eNB_id);
70

71
/*!
72 73 74 75 76 77 78 79 80
\brief This function performs the coarse frequency and PSS synchronization.
The algorithm uses a frequency-domain correlation.  It scans over 20 MHz/10ms signal chunks using each of the 3 PSS finding the most likely (strongest) carriers and their frequency offset (+-2.5 kHz).
\param ue Pointer to UE data structure
\param band index of band in scan_info structure, used to store statistics
\param DL_freq center frequency of band being scanned, used when storing statistics
*/
void lte_sync_timefreq(PHY_VARS_UE *ue,int band,unsigned int DL_freq);


81
/*!
82
\brief This function performs detection of the PRACH (=SRS) at the eNb to estimate the timing advance
83
The algorithm uses a time domain correlation with a downsampled version of the received signal.
84 85 86
\param rxdata Received time domain data for all rx antennas
\param frame_parms LTE DL frame parameter structure
\param length Length for correlation
87
\param peak_val pointer to value of returned peak
88 89
\param sync_corr_eNb pointer to correlation buffer
\return sync_pos Position of the sync within the frame (downsampled) if successfull and -1 if there was an error or no peak was detected.
gauthier's avatar
gauthier committed
90 91
 */
int lte_sync_time_eNB(int32_t **rxdata,
92 93 94 95
                      LTE_DL_FRAME_PARMS *frame_parms,
                      uint32_t length,
                      uint32_t *peak_val,
                      uint32_t *sync_corr_eNb);
96 97

int lte_sync_time_eNB_emul(PHY_VARS_eNB *phy_vars_eNb,
98 99
                           uint8_t sect_id,
                           int32_t *sync_val);
100 101 102 103 104 105 106

/*!
\brief This function performs channel estimation including frequency and temporal interpolation
\param phy_vars_ue Pointer to UE PHY variables
\param eNB_id Index of target eNB
\param eNB_offset Offset for interfering eNB (in terms cell ID mod 3)
\param Ns slot number (0..19)
107
\param p antenna port
108 109 110 111
\param l symbol within slot
\param symbol symbol within frame
*/
int lte_dl_channel_estimation(PHY_VARS_UE *phy_vars_ue,
112 113 114 115 116 117
                              module_id_t eNB_id,
                              uint8_t eNB_offset,
                              uint8_t Ns,
                              uint8_t p,
                              uint8_t l,
                              uint8_t symbol);
118

119 120 121 122 123 124 125
int lte_dl_bf_channel_estimation(PHY_VARS_UE *phy_vars_ue,
                                 module_id_t eNB_id,
                                 uint8_t eNB_offset,
                                 uint8_t Ns,
                                 uint8_t p,
                                 uint8_t symbol);

126
int lte_dl_msbfn_channel_estimation(PHY_VARS_UE *phy_vars_ue,
127 128 129 130 131
                                    module_id_t eNB_id,
                                    uint8_t eNB_offset,
                                    int subframe,
                                    unsigned char l,
                                    unsigned char symbol);
132

133
int lte_dl_mbsfn_channel_estimation(PHY_VARS_UE *phy_vars_ue,
134 135 136 137
                                    module_id_t eNB_id,
                                    uint8_t eNB_offset,
                                    int subframe,
                                    unsigned char l);
138 139 140 141

/*
#ifdef EMOS
int lte_dl_channel_estimation_emos(int dl_ch_estimates_emos[NB_ANTENNAS_RX*NB_ANTENNAS_TX][N_RB_DL_EMOS*N_PILOTS_PER_RB*N_SLOTS_EMOS],
142 143 144 145 146 147
           int **rxdataF,
           LTE_DL_FRAME_PARMS *frame_parms,
           unsigned char Ns,
           unsigned char p,
           unsigned char l,
           unsigned char sector);
148
#endif
gauthier's avatar
gauthier committed
149
 */
150 151 152 153 154 155 156 157

/*!
\brief Frequency offset estimation for LTE
We estimate the frequency offset by calculating the phase difference between channel estimates for symbols carrying pilots (l==0 or l==3/4). We take a moving average of the phase difference.
\param dl_ch_estimates pointer to structure that holds channel estimates (one slot)
\param frame_parms pointer to LTE frame parameters
\param l symbol within slot
\param freq_offset pointer to the returned frequency offset
158
\param reset When non-zer it resets the filter to the initial value (set whenever tuning has been changed or for a one-shot estimate)
gauthier's avatar
gauthier committed
159
 */
160
int lte_est_freq_offset(int **dl_ch_estimates,
161 162
                        LTE_DL_FRAME_PARMS *frame_parms,
                        int l,
163 164
                        int* freq_offset,
			int reset);
165 166

int lte_mbsfn_est_freq_offset(int **dl_ch_estimates,
167 168 169
                              LTE_DL_FRAME_PARMS *frame_parms,
                              int l,
                              int* freq_offset);
170 171 172 173 174

/*! \brief Tracking of timing for LTE
This function computes the time domain channel response, finds the peak and adjusts the timing in pci_interface.offset accordingly.
\param frame_parms LTE DL frame parameter structure
\param phy_vars_ue Pointer to UE PHY data structure
175
\param eNb_id
176 177
\param clear If clear==1 moving average filter is reset
\param coef Coefficient of the moving average filter (Q1.15)
gauthier's avatar
gauthier committed
178
 */
179 180

void lte_adjust_synch(LTE_DL_FRAME_PARMS *frame_parms,
181 182
                      PHY_VARS_UE *phy_vars_ue,
                      module_id_t eNb_id,
183
					  uint8_t subframe,
184 185
                      unsigned char clear,
                      short coef);
186 187 188

//! \brief this function fills the PHY_VARS_UE->PHY_measurement structure
void lte_ue_measurements(PHY_VARS_UE *phy_vars_ue,
189 190
                         unsigned int subframe_offset,
                         unsigned char N0_symbol,
191 192
                         unsigned char abstraction_flag,
						 uint8_t subframe);
193 194 195

//! \brief This function performance RSRP/RSCP measurements
void ue_rrc_measurements(PHY_VARS_UE *phy_vars_ue,
196 197
                         uint8_t slot,
                         uint8_t abstraction_flag);
gauthier's avatar
gauthier committed
198 199

void lte_ue_measurements_emul(PHY_VARS_UE *phy_vars_ue,uint8_t last_slot,uint8_t eNB_id);
200 201 202 203 204

/*! \brief Function to return the path-loss based on the UE cell-specific reference signal strength and transmission power of eNB
@param Mod_id Module ID for UE
@param eNB_index Index of eNB on which to act
@returns Path loss in dB
gauthier's avatar
gauthier committed
205
 */
knopp's avatar
 
knopp committed
206
int16_t get_PL(module_id_t Mod_id,uint8_t CC_id,uint8_t eNB_index);
207 208
uint32_t get_RSRP(module_id_t Mod_id,uint8_t CC_id,uint8_t eNB_index);
uint32_t get_RSRQ(module_id_t Mod_id,uint8_t CC_id,uint8_t eNB_index);
knopp's avatar
 
knopp committed
209
uint8_t get_n_adj_cells(module_id_t Mod_id,uint8_t CC_id);
210 211
uint32_t get_rx_total_gain_dB(module_id_t Mod_id,uint8_t CC_id);
uint32_t get_RSSI(module_id_t Mod_id,uint8_t CC_id);
knopp's avatar
 
knopp committed
212 213
int8_t set_RSRP_filtered(module_id_t Mod_id,uint8_t CC_id,uint8_t eNB_index,float rsrp);
int8_t set_RSRQ_filtered(module_id_t Mod_id,uint8_t CC_id,uint8_t eNB_index,float rstq);
214 215 216

//! Automatic gain control
void phy_adjust_gain (PHY_VARS_UE *phy_vars_ue,
217
		      uint32_t rx_power_fil_dB,
218
                      unsigned char eNB_id);
219 220

int lte_ul_channel_estimation(PHY_VARS_eNB *phy_vars_eNB,
knopp's avatar
knopp committed
221
			      eNB_rxtx_proc_t *proc,
222 223
                              module_id_t UE_id,
                              uint8_t l,
224 225
                              uint8_t Ns);

226

gauthier's avatar
gauthier committed
227
int16_t lte_ul_freq_offset_estimation(LTE_DL_FRAME_PARMS *frame_parms,
228 229
                                      int32_t *ul_ch_estimates,
                                      uint16_t nb_rb);
230 231

int lte_srs_channel_estimation(LTE_DL_FRAME_PARMS *frame_parms,
232 233
                               LTE_eNB_COMMON *eNB_common_vars,
                               LTE_eNB_SRS *eNB_srs_vars,
234 235
                               SOUNDINGRS_UL_CONFIG_DEDICATED *soundingrs_ul_config_dedicated,
                               unsigned char sub_frame_number,
236
			       unsigned char eNB_id);
237 238

int lte_est_timing_advance(LTE_DL_FRAME_PARMS *frame_parms,
239 240 241 242 243
                           LTE_eNB_SRS *lte_eNb_srs,
                           unsigned int *eNb_id,
                           unsigned char clear,
                           unsigned char number_of_cards,
                           short coef);
244

245
int lte_est_timing_advance_pusch(PHY_VARS_eNB* phy_vars_eNB,module_id_t UE_id);
246

247 248
void lte_eNB_I0_measurements(PHY_VARS_eNB *phy_vars_eNB,
			     int subframe,
249 250
                             module_id_t eNB_id,
                             unsigned char clear);
251

252
void lte_eNB_I0_measurements_emul(PHY_VARS_eNB *phy_vars_eNB,
253
                                  uint8_t sect_id);
254 255


256
void lte_eNB_srs_measurements(PHY_VARS_eNB *phy_vars_eNBy,
257 258 259
                              module_id_t eNB_id,
                              module_id_t UE_id,
                              unsigned char init_averaging);
260 261 262


void freq_equalization(LTE_DL_FRAME_PARMS *frame_parms,
263 264 265 266 267 268
                       int **rxdataF_comp,
                       int **ul_ch_mag,
                       int **ul_ch_mag_b,
                       unsigned char symbol,
                       unsigned short Msc_RS,
                       unsigned char Qm);
269 270


271
/** @} */
272
#endif