defs.h 15.7 KB
Newer Older
1 2 3 4 5
/*
 * 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
6
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * 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
 */

22 23 24 25 26
#ifndef __INIT_DEFS__H__
#define __INIT_DEFS__H__

#include "PHY/defs.h"

27

28 29 30 31
#include "SystemInformationBlockType2.h"
//#include "RadioResourceConfigCommonSIB.h"
#include "RadioResourceConfigDedicated.h"
#include "TDD-Config.h"
32
#include "PHICH-Config.h"
33
#include "MBSFN-SubframeConfigList.h"
34
#include "MobilityControlInfo.h"
35
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
36
#include "SCellToAddMod-r10.h"
37
#endif
38 39 40 41
/** @addtogroup _PHY_STRUCTURES_
 * @{
 */

42 43 44 45 46 47 48
/*!
\fn int l1_top_init_eNB(void)
\brief Initialize north interface for L1
@returns 0 on success
 */
int l1_north_init_eNB(void);

49 50 51 52 53
/*!
\fn int phy_init_top(LTE_DL_FRAME_PARMS *frame_parms)
\brief Allocate and Initialize the PHY variables after receiving static configuration
@param frame_parms Pointer to LTE_DL_FRAME_PARMS (common configuration)
@returns 0 on success
54
 */
55 56 57 58
int phy_init_top(LTE_DL_FRAME_PARMS *frame_parms);


/*!
59
\brief Allocate and Initialize the PHY variables relevant to the LTE ue signal buffers.
60 61
\details Only a subset of phy_vars_ue is initialized.
@param[out] phy_vars_ue Pointer to UE Variables
62 63 64
@param nb_connected_eNB Number of eNB that UE can process in one PDSCH demodulation subframe
@param abstraction_flag 1 indicates memory should be allocated for abstracted MODEM
@returns 0 on success
65 66
@returns -1 if any memory allocation failed
@note The current implementation will never return -1, but segfault.
67
 */
Cedric Roux's avatar
Cedric Roux committed
68
int init_lte_ue_signal(PHY_VARS_UE *phy_vars_ue,
69 70 71 72 73 74 75 76 77
			   int          nb_connected_eNB,
			   uint8_t         abstraction_flag);

/*!
\brief Allocate and initialize the PHY variables releated to the transport channel buffers (UL/DL)
@param ue Pointer to UE L1 context
@param abstraction flag Indicates that abstraction is used in L1
*/
void init_lte_ue_transport(PHY_VARS_UE *ue,int absraction_flag);
78 79

/*!
80 81 82
\brief Allocate and initialize the PHY variables relevant to the LTE implementation (eNB).
\details Only a subset of phy_vars_eNb is initialized.
@param[out] phy_vars_eNb Pointer to eNB Variables
83 84 85
@param is_secondary_eNb Flag to indicate this eNB gets synch from another
@param abstraction_flag 1 indicates memory should be allocated for abstracted MODEM
@returns 0 on success
86 87
@returns -1 if any memory allocation failed
@note The current implementation will never return -1, but segfault.
88
 */
89
int phy_init_lte_eNB(PHY_VARS_eNB *phy_vars_eNb,
90 91
                     unsigned char is_secondary_eNb,
                     unsigned char abstraction_flag);
92

93 94 95 96 97 98 99
/*!
\brief Free the PHY variables relevant to the LTE implementation (eNB).
\details Only a subset of phy_vars_eNb is freed (those who have been allocated with phy_init_lte_eNB()).
@param[in] phy_vars_eNb Pointer to eNB Variables
 */
void phy_free_lte_eNB(PHY_VARS_eNB *phy_vars_eNb);

100 101
/** \brief Configure LTE_DL_FRAME_PARMS with components derived after initial synchronization (MIB decoding + primary/secondary synch).
\details The basically allows configuration of \f$N_{\mathrm{RB}}^{\mathrm{DL}}\f$, the cell id  \f$N_{\mathrm{ID}}^{\mathrm{cell}}\f$, the normal/extended prefix mode, the frame type (FDD/TDD), \f$N_{\mathrm{cp}}\f$, the number of TX antennas at eNB (\f$p\f$) and the number of PHICH groups, \f$N_{\mathrm{group}}^{\mathrm{PHICH}}\f$
102 103 104 105 106 107
@param lte_frame_parms pointer to LTE parameter structure
@param N_RB_DL Number of DL resource blocks
@param Nid_cell Cell ID
@param Ncp Normal/Extended Prefix flag
@param p_eNB Number of eNB TX antennas
@param phich_config Pointer to PHICH_CONFIG_COMMON
108
 */
109 110 111 112 113 114 115 116 117 118 119
void phy_config_mib_eNB(int                    Mod_id,
			int                    CC_id,
			int                    eutra_band,
			int                    N_RB_DL,
			PHICH_Config_t         *phich_config,
			int                    Nid_cell,
			int                    Ncp,
			int                    p_eNB,
			uint32_t               dl_CarrierFreq,
			uint32_t               ul_CarrierFreq);

120 121


122 123
/** \brief Configure LTE_DL_FRAME_PARMS with components derived after reception of SIB1.
\details From a PHY perspective this allows configuration of TDD framing parameters and SI reception.
124
@param Mod_id Instance ID of eNB
knopp's avatar
knopp committed
125
@param CC_id Component Carrier index
126
@param tdd_Config TDD UL/DL and S-subframe configurations
127
@param SIwindowsize Size of a SI window in frames where repetitions of a unique System Information message block is repeated
128
@param SIperiod Periodicity of System Information Messages (in multiples of a frame)*/
129
void phy_config_sib1_eNB(module_id_t    Mod_id,
knopp's avatar
knopp committed
130
                         int CC_id,
131
                         TDD_Config_t  *tdd_Config,
132 133
                         uint8_t           SIwindowsize,
                         uint16_t            SIperiod);
134

135 136
/** \brief Configure LTE_DL_FRAME_PARMS with components derived after reception of SIB1.
\details From a PHY perspective this allows configuration of TDD framing parameters and SI reception.
137
@param Mod_id Instance ID of UE
knopp's avatar
knopp committed
138
@param CC_id Component Carrier index
139 140
@param CH_index Index of eNB for this configuration
@param tdd_Config TDD UL/DL and S-subframe configurations
141
@param SIwindowsize Size of a SI window in frames where repetitions of a unique System Information message block is repeated
142
@param SIperiod Periodicity of System Information Messages (in multiples of a frame)*/
143
void phy_config_sib1_ue(module_id_t   Mod_id,
knopp's avatar
knopp committed
144
                        int CC_id,
145
                        uint8_t          CH_index,
146 147 148
                        TDD_Config_t *tdd_Config,
                        uint8_t          SIwindowsize,
                        uint16_t           SIperiod);
149 150 151


/*!
knopp's avatar
knopp committed
152
  \fn void phy_config_sib2_ue(module_id_t Mod_id,uint8_t CC_id,uint8_t CH_index,
153 154 155 156 157 158
      RadioResourceConfigCommonSIB_t *radioResourceConfigCommon,
      ARFCN_ValueEUTRA_t *ul_CArrierFreq,
            long *ul_Bandwidth,
      AdditionalSpectrumEmission_t additionalSpectrumEmission,
      struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList)
  \brief Configure LTE_DL_FRAME_PARMS with components derived after reception of SIB2 (at UE).
159
  @param Mod_id Instance id
knopp's avatar
knopp committed
160
  @param CC_id
161
  @param CH_index Index of CH to which UE is connected
knopp's avatar
knopp committed
162
  @param CC_id Component Carrier Index
163 164 165 166 167
  @param radioResourceConfigCommon Radio Configuration from SIB2
  @param ul_CarrierFreq UL carrier ARFCN, null if optional (i.e. implicit from DL)
  @param ul_Bandwidth UL bandwidth, null if optional (i.e. same as DL)
  @param additionalSpectrumEmission UL parameter (see 36.101)
  @param mbsfn_SubframeConfigList MBSFN subframe configuration
168
 */
knopp's avatar
knopp committed
169 170
void phy_config_sib2_ue(module_id_t                     Mod_id,
                        int                         CC_id,
171
                        uint8_t                         CH_index,
172 173 174 175 176
                        RadioResourceConfigCommonSIB_t  *radioResourceConfigCommon,
                        ARFCN_ValueEUTRA_t              *ul_CArrierFreq,
                        long                            *ul_Bandwidth,
                        AdditionalSpectrumEmission_t    *additionalSpectrumEmission,
                        struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList);
177

178

179
/*!
180 181
  \fn phy_config_afterHO_ue
  \brief Configure Common PHY parameters from mobilityControlInfo
182
  @param Mod_id
knopp's avatar
knopp committed
183
  @param CC_id
184 185 186 187
  @param eNB_index
  @param mobilityControlInfo pointer to the mobility control information for handover
  @param ho_failed flag to indicated whether the ho was successful or not
 */
188
void phy_config_afterHO_ue(module_id_t Mod_id,
189
                           uint8_t CC_id,
190
                           uint8_t eNB_index,
191 192
                           MobilityControlInfo_t *mobilityControlInfo,
                           uint8_t ho_failed);
193
/*!
194
  \fn void phy_config_sib2_eNB(module_id_t Mod_id,
195
                               RadioResourceConfigCommonSIB_t *radioResourceConfigCommon,
196 197 198 199 200
             ARFCN_ValueEUTRA_t *ul_CArrierFreq,
             long *ul_Bandwidth,
             AdditionalSpectrumEmission_t additionalSpectrumEmission,
             struct MBSFN_SubframeConfigList  *mbsfn_SubframeConfigList)
  \brief Configure LTE_DL_FRAME_PARMS with components of SIB2 (at eNB).
201
  @param Mod_id Instance id
knopp's avatar
knopp committed
202
  @param Mod_id Component Carrier index
203 204 205 206 207
  @param radioResourceConfigCommon Radio Configuration from SIB2
  @param ul_CarrierFreq UL carrier ARFCN, null if optional (i.e. implicit from DL)
  @param ul_Bandwidth UL bandwidth, null if optional (i.e. same as DL)
  @param additionalSpectrumEmission UL parameter (see 36.101)
  @param mbsfn_SubframeConfigList MBSFN subframe configuration
208
 */
knopp's avatar
knopp committed
209 210
void phy_config_sib2_eNB(module_id_t                            Mod_id,
                         int                                CC_id,
211
                         RadioResourceConfigCommonSIB_t         *radioResourceConfigCommon,
212 213 214 215
                         ARFCN_ValueEUTRA_t                     *ul_CArrierFreq,
                         long                                   *ul_Bandwidth,
                         AdditionalSpectrumEmission_t           *additionalSpectrumEmission,
                         struct MBSFN_SubframeConfigList        *mbsfn_SubframeConfigList);
216 217 218


/*!
knopp's avatar
knopp committed
219
\fn void phy_config_dedicated_ue(module_id_t Mod_id,uint8_t CC_id,uint8_t CH_index,
220
               struct PhysicalConfigDedicated *physicalConfigDedicated)
221 222
\brief Configure UE dedicated parameters.
\details Invoked upon reception of RRCConnectionSetup or RRCConnectionReconfiguration from eNB.
223
@param Mod_id Instance ID for eNB
knopp's avatar
knopp committed
224
@param CC_id Component Carrier index
225 226 227
@param CH_index Index of eNB for this configuration
@param physicalConfigDedicated PHY Configuration information

228
 */
knopp's avatar
knopp committed
229 230
void phy_config_dedicated_ue(module_id_t Mod_id,
                             int CC_id,
231
                             uint8_t CH_index,
knopp's avatar
knopp committed
232 233
                             struct PhysicalConfigDedicated *physicalConfigDedicated);

234 235 236 237 238 239 240 241 242
/*!
\fn void phy_config_harq_ue(module_id_t Mod_id,uint8_t CC_id,uint8_t CH_index,
               uint16_t max_harq_tx)
\brief Configure UE UL max harq Tx.
\details Invoked upon reception of RRCConnectionSetup or RRCConnectionReconfiguration from eNB.
@param Mod_id Instance ID for eNB
@param CC_id Component Carrier index
@param CH_index Index of eNB for this configuration
@param max_harq_tx max harq tx information
243

244 245 246
 */
void phy_config_harq_ue(module_id_t Mod_id,int CC_id,uint8_t CH_index,
                           uint16_t max_harq_tx);
247
/**
248 249
\brief Configure UE MBSFN common parameters.
\details Invoked upon reception of SIB13 from eNB.
250
@param Mod_id Instance ID for UE
knopp's avatar
knopp committed
251
@param CC_id Component Carrier Index
252 253 254
@param CH_index eNB id (for multiple eNB reception)
@param mbsfn_Area_idx Index of MBSFN-Area for which this command operates
@param mbsfn_AreaId_r9 MBSFN-Area Id
255
 */
256

257
void phy_config_sib13_ue(module_id_t Mod_id,
knopp's avatar
knopp committed
258
                         int CC_id,uint8_t CH_index,int mbsfn_Area_idx,
259
                         long mbsfn_AreaId_r9);
260 261

/**
262 263
\brief Configure eNB MBSFN common parameters.
\details Invoked upon transmission of SIB13 from eNB.
264
@param Mod_id Instance ID for eNB
knopp's avatar
knopp committed
265
@param CC_id Component Carrier index
266 267
@param mbsfn_Area_idx Index of MBSFN-Area for which this command operates
@param mbsfn_AreaId_r9 MBSFN-Area Id
268 269
 */
void phy_config_sib13_eNB(module_id_t Mod_id,
270
                          int CC_id,
271 272
                          int mbsfn_Area_idx,
                          long mbsfn_AreaId_r9);
273 274 275 276

/**
\brief Configure cba rnti for .
@param Mod_id Instance ID for eNB
knopp's avatar
knopp committed
277
@param CC_id Component Carrier Index
278
@param eNB_flag flag indicating whether the nodeis eNB (1) or UE (0)
279
@param index index of the node
280 281
@param cba_rnti rnti for the cba transmission
@param num_active_cba_groups num active cba group
282
 */
knopp's avatar
knopp committed
283
void  phy_config_cba_rnti (module_id_t Mod_id,int CC_id,eNB_flag_t eNB_flag, uint8_t index, rnti_t cba_rnti, uint8_t cba_group_id, uint8_t num_active_cba_groups);
284 285 286

/** \brief Configure RRC inter-cell measurements procedures
@param Mod_id Index of UE
knopp's avatar
knopp committed
287
@param CC_id
288 289 290
@param eNB_index Index of corresponding eNB
@param n_adj_cells Number of adjacent cells on which to perform the measuremnts
@param adj_cell_id Array of cell ids of adjacent cells
291 292
 */
void phy_config_meas_ue(module_id_t Mod_id,
293
                        uint8_t CC_id,
294
                        uint8_t eNB_index,
295 296
                        uint8_t n_adj_cells,
                        uint32_t *adj_cell_id);
297 298

/*!
299
\fn void phy_config_dedicated_eNB(module_id_t Mod_id,uint16_t rnti,
300
                                  struct PhysicalConfigDedicated *physicalConfigDedicated)
301 302
\brief Prepare for configuration of PHY with dedicated parameters.
\details Invoked just prior to transmission of RRCConnectionSetup or RRCConnectionReconfiguration at eNB.
303
@param Mod_id Instance ID for eNB
knopp's avatar
knopp committed
304
@param CC_id Component Carrier index
305 306
@param rnti rnti for UE context
@param physicalConfigDedicated PHY Configuration information
307 308
 */
void phy_config_dedicated_eNB(module_id_t Mod_id,
knopp's avatar
knopp committed
309
                              int CC_id,
310
                              rnti_t rnti,
311
                              struct PhysicalConfigDedicated *physicalConfigDedicated);
312 313 314 315 316

/*!
\fn void phy_config_dedicated_eNB_step2(PHY_VARS_eNB *phy_vars_eNB)
\brief Configure PHY with dedicated parameters between configuration of DLSCH (n) and ULSCH (n+4) in current subframe (n).
@param phy_vars_eNB Pointer to PHY_VARS_eNB structure
317
 */
318 319 320 321
void phy_config_dedicated_eNB_step2(PHY_VARS_eNB *phy_vars_eNB);

/*
  \fn int phy_init_secsys_eNB(PHY_VARS_eNB *phy_vars_eNb)
322
\brief Allocate and Initialize the PHY variables relevant to the LTE implementation.
323
@param phy_vars_eNb pointer to LTE parameter structure for the eNb
324
 */
325 326
int phy_init_secsys_eNB(PHY_VARS_eNB *phy_vars_eNb);

327
void free_lte_top(void);
328

329
void init_lte_top(LTE_DL_FRAME_PARMS *lte_frame_parms);
330 331 332

//void copy_lte_parms_to_phy_framing(LTE_DL_FRAME_PARMS *frame_parm, PHY_FRAMING *phy_framing);

knopp's avatar
knopp committed
333 334 335
void lte_param_init(PHY_VARS_eNB **eNBp,
		    PHY_VARS_UE **UEp,
		    RU_t **rup,
Cedric Roux's avatar
Cedric Roux committed
336
		    unsigned char N_tx_port_eNB,
knopp's avatar
knopp committed
337
                    unsigned char N_tx_phy,
338 339
		    unsigned char N_rx_ru,
		    unsigned char N_rx_ue,
340 341
		    unsigned char transmission_mode,
		    uint8_t extended_prefix_flag,
Cedric Roux's avatar
Cedric Roux committed
342
		    frame_t frame_type,
343 344 345
		    uint16_t Nid_cell,
		    uint8_t tdd_config,
		    uint8_t N_RB_DL,
knopp's avatar
knopp committed
346
		    uint8_t pa,
347 348 349 350
		    uint8_t threequarter_fs,
                    uint8_t osf,
		    uint32_t perfect_ce);

knopp's avatar
knopp committed
351

352
#if (RRC_VERSION >= MAKE_VERSION(10, 0, 0))
353
void phy_config_dedicated_scell_ue(uint8_t Mod_id,
354 355 356
                                   uint8_t eNB_index,
                                   SCellToAddMod_r10_t *sCellToAddMod_r10,
                                   int CC_id);
357 358

void phy_config_dedicated_scell_eNB(uint8_t Mod_id,
359 360 361
                                    uint16_t rnti,
                                    SCellToAddMod_r10_t *sCellToAddMod_r10,
                                    int CC_id);
362

363
#endif
364

365 366 367


/*! !\fn void phy_cleanup(void)
368
\brief Cleanup the PHY variables*/
369 370
void phy_cleanup(void);

371
void phy_config_request(PHY_Config_t *phy_config);
372

373
int init_frame_parms(LTE_DL_FRAME_PARMS *frame_parms,uint8_t osf);
374
void dump_frame_parms(LTE_DL_FRAME_PARMS *frame_parms);
375

376 377 378
/** @} */
#endif