defs.h 15.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * 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
 */

22 23 24 25 26
#ifndef __INIT_DEFS__H__
#define __INIT_DEFS__H__

#include "PHY/defs.h"

27

28 29 30 31 32
#include "SystemInformationBlockType2.h"
//#include "RadioResourceConfigCommonSIB.h"
#include "RadioResourceConfigDedicated.h"
#include "TDD-Config.h"
#include "MBSFN-SubframeConfigList.h"
33
#include "MobilityControlInfo.h"
34 35
#ifdef Rel10
#include "SCellToAddMod-r10.h"
36
#endif
37 38 39 40 41 42 43 44 45
/** @addtogroup _PHY_STRUCTURES_
 * @{
 */

/*!
\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
gauthier's avatar
gauthier committed
46
 */
47 48 49 50
int phy_init_top(LTE_DL_FRAME_PARMS *frame_parms);


/*!
51 52 53
\brief Allocate and Initialize the PHY variables relevant to the LTE implementation.
\details Only a subset of phy_vars_ue is initialized.
@param[out] phy_vars_ue Pointer to UE Variables
54 55 56
@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
57 58
@returns -1 if any memory allocation failed
@note The current implementation will never return -1, but segfault.
gauthier's avatar
gauthier committed
59
 */
60
int phy_init_lte_ue(PHY_VARS_UE *phy_vars_ue,
gauthier's avatar
gauthier committed
61 62
                    int          nb_connected_eNB,
                    uint8_t         abstraction_flag);
63 64

/*!
65 66 67
\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
68 69 70
@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
71 72
@returns -1 if any memory allocation failed
@note The current implementation will never return -1, but segfault.
gauthier's avatar
gauthier committed
73
 */
74
int phy_init_lte_eNB(PHY_VARS_eNB *phy_vars_eNb,
gauthier's avatar
gauthier committed
75 76
                     unsigned char is_secondary_eNb,
                     unsigned char abstraction_flag);
77

78 79
/** \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$
80 81 82 83 84 85 86
@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 frame_type FDD/TDD framing
@param p_eNB Number of eNB TX antennas
@param phich_config Pointer to PHICH_CONFIG_COMMON
gauthier's avatar
gauthier committed
87
 */
88
void phy_config_mib(LTE_DL_FRAME_PARMS *lte_frame_parms,
gauthier's avatar
gauthier committed
89 90 91 92 93 94
                    uint8_t                N_RB_DL,
                    uint8_t                Nid_cell,
                    uint8_t                Ncp,
                    uint8_t                frame_type,
                    uint8_t                p_eNB,
                    PHICH_CONFIG_COMMON *phich_config);
95 96


97 98
/** \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.
99
@param Mod_id Instance ID of eNB
knopp's avatar
 
knopp committed
100
@param CC_id Component Carrier index
101
@param tdd_Config TDD UL/DL and S-subframe configurations
102
@param SIwindowsize Size of a SI window in frames where repetitions of a unique System Information message block is repeated
103
@param SIperiod Periodicity of System Information Messages (in multiples of a frame)*/
gauthier's avatar
gauthier committed
104
void phy_config_sib1_eNB(module_id_t    Mod_id,
knopp's avatar
 
knopp committed
105
                         int CC_id,
106
                         TDD_Config_t  *tdd_Config,
gauthier's avatar
gauthier committed
107 108
                         uint8_t           SIwindowsize,
                         uint16_t            SIperiod);
109

110 111
/** \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.
112
@param Mod_id Instance ID of UE
knopp's avatar
 
knopp committed
113
@param CC_id Component Carrier index
114 115
@param CH_index Index of eNB for this configuration
@param tdd_Config TDD UL/DL and S-subframe configurations
116
@param SIwindowsize Size of a SI window in frames where repetitions of a unique System Information message block is repeated
117
@param SIperiod Periodicity of System Information Messages (in multiples of a frame)*/
gauthier's avatar
gauthier committed
118
void phy_config_sib1_ue(module_id_t   Mod_id,
knopp's avatar
 
knopp committed
119
                        int CC_id,
120
                        uint8_t          CH_index,
gauthier's avatar
gauthier committed
121 122 123
                        TDD_Config_t *tdd_Config,
                        uint8_t          SIwindowsize,
                        uint16_t           SIperiod);
124 125 126


/*!
knopp's avatar
 
knopp committed
127
  \fn void phy_config_sib2_ue(module_id_t Mod_id,uint8_t CC_id,uint8_t CH_index,
128 129 130 131 132 133
      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).
134
  @param Mod_id Instance id
knopp's avatar
 
knopp committed
135
  @param CC_id
136
  @param CH_index Index of CH to which UE is connected
knopp's avatar
 
knopp committed
137
  @param CC_id Component Carrier Index
138 139 140 141 142
  @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
gauthier's avatar
gauthier committed
143
 */
knopp's avatar
 
knopp committed
144 145
void phy_config_sib2_ue(module_id_t                     Mod_id,
                        int                         CC_id,
146
                        uint8_t                         CH_index,
gauthier's avatar
gauthier committed
147 148 149 150 151
                        RadioResourceConfigCommonSIB_t  *radioResourceConfigCommon,
                        ARFCN_ValueEUTRA_t              *ul_CArrierFreq,
                        long                            *ul_Bandwidth,
                        AdditionalSpectrumEmission_t    *additionalSpectrumEmission,
                        struct MBSFN_SubframeConfigList *mbsfn_SubframeConfigList);
152

153

154
/*!
155 156
  \fn phy_config_afterHO_ue
  \brief Configure Common PHY parameters from mobilityControlInfo
157
  @param Mod_id
knopp's avatar
 
knopp committed
158
  @param CC_id
159 160 161 162
  @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
 */
gauthier's avatar
gauthier committed
163
void phy_config_afterHO_ue(module_id_t Mod_id,
164
                           uint8_t CC_id,
165
                           uint8_t eNB_index,
gauthier's avatar
gauthier committed
166 167
                           MobilityControlInfo_t *mobilityControlInfo,
                           uint8_t ho_failed);
168
/*!
gauthier's avatar
gauthier committed
169
  \fn void phy_config_sib2_eNB(module_id_t Mod_id,
170
                               RadioResourceConfigCommonSIB_t *radioResourceConfigCommon,
171 172 173 174 175
             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).
176
  @param Mod_id Instance id
knopp's avatar
 
knopp committed
177
  @param Mod_id Component Carrier index
178 179 180 181 182
  @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
gauthier's avatar
gauthier committed
183
 */
knopp's avatar
 
knopp committed
184 185
void phy_config_sib2_eNB(module_id_t                            Mod_id,
                         int                                CC_id,
186
                         RadioResourceConfigCommonSIB_t         *radioResourceConfigCommon,
gauthier's avatar
gauthier committed
187 188 189 190
                         ARFCN_ValueEUTRA_t                     *ul_CArrierFreq,
                         long                                   *ul_Bandwidth,
                         AdditionalSpectrumEmission_t           *additionalSpectrumEmission,
                         struct MBSFN_SubframeConfigList        *mbsfn_SubframeConfigList);
191 192 193


/*!
knopp's avatar
 
knopp committed
194
\fn void phy_config_dedicated_ue(module_id_t Mod_id,uint8_t CC_id,uint8_t CH_index,
195
               struct PhysicalConfigDedicated *physicalConfigDedicated)
196 197
\brief Configure UE dedicated parameters.
\details Invoked upon reception of RRCConnectionSetup or RRCConnectionReconfiguration from eNB.
198
@param Mod_id Instance ID for eNB
knopp's avatar
 
knopp committed
199
@param CC_id Component Carrier index
200 201 202
@param CH_index Index of eNB for this configuration
@param physicalConfigDedicated PHY Configuration information

gauthier's avatar
gauthier committed
203
 */
knopp's avatar
 
knopp committed
204 205
void phy_config_dedicated_ue(module_id_t Mod_id,
                             int CC_id,
206
                             uint8_t CH_index,
knopp's avatar
 
knopp committed
207 208
                             struct PhysicalConfigDedicated *physicalConfigDedicated);

Bilel's avatar
Bilel committed
209 210 211 212 213 214 215 216 217
/*!
\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
218

Bilel's avatar
Bilel committed
219 220 221
 */
void phy_config_harq_ue(module_id_t Mod_id,int CC_id,uint8_t CH_index,
                           uint16_t max_harq_tx);
222
/**
223 224
\brief Configure UE MBSFN common parameters.
\details Invoked upon reception of SIB13 from eNB.
225
@param Mod_id Instance ID for UE
knopp's avatar
 
knopp committed
226
@param CC_id Component Carrier Index
227 228 229
@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
gauthier's avatar
gauthier committed
230
 */
231

gauthier's avatar
gauthier committed
232
void phy_config_sib13_ue(module_id_t Mod_id,
knopp's avatar
 
knopp committed
233
                         int CC_id,uint8_t CH_index,int mbsfn_Area_idx,
gauthier's avatar
gauthier committed
234
                         long mbsfn_AreaId_r9);
235 236

/**
237 238
\brief Configure eNB MBSFN common parameters.
\details Invoked upon transmission of SIB13 from eNB.
239
@param Mod_id Instance ID for eNB
knopp's avatar
 
knopp committed
240
@param CC_id Component Carrier index
241 242
@param mbsfn_Area_idx Index of MBSFN-Area for which this command operates
@param mbsfn_AreaId_r9 MBSFN-Area Id
gauthier's avatar
gauthier committed
243 244
 */
void phy_config_sib13_eNB(module_id_t Mod_id,
245
                          int CC_id,
gauthier's avatar
gauthier committed
246 247
                          int mbsfn_Area_idx,
                          long mbsfn_AreaId_r9);
248 249 250 251

/**
\brief Configure cba rnti for .
@param Mod_id Instance ID for eNB
knopp's avatar
 
knopp committed
252
@param CC_id Component Carrier Index
253
@param eNB_flag flag indicating whether the nodeis eNB (1) or UE (0)
254
@param index index of the node
255 256
@param cba_rnti rnti for the cba transmission
@param num_active_cba_groups num active cba group
gauthier's avatar
gauthier committed
257
 */
knopp's avatar
 
knopp committed
258
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);
259 260 261

/** \brief Configure RRC inter-cell measurements procedures
@param Mod_id Index of UE
knopp's avatar
 
knopp committed
262
@param CC_id
263 264 265
@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
gauthier's avatar
gauthier committed
266 267
 */
void phy_config_meas_ue(module_id_t Mod_id,
268
                        uint8_t CC_id,
269
                        uint8_t eNB_index,
gauthier's avatar
gauthier committed
270 271
                        uint8_t n_adj_cells,
                        uint32_t *adj_cell_id);
272 273

/*!
gauthier's avatar
gauthier committed
274
\fn void phy_config_dedicated_eNB(module_id_t Mod_id,uint16_t rnti,
275
                                  struct PhysicalConfigDedicated *physicalConfigDedicated)
276 277
\brief Prepare for configuration of PHY with dedicated parameters.
\details Invoked just prior to transmission of RRCConnectionSetup or RRCConnectionReconfiguration at eNB.
278
@param Mod_id Instance ID for eNB
knopp's avatar
 
knopp committed
279
@param CC_id Component Carrier index
280 281
@param rnti rnti for UE context
@param physicalConfigDedicated PHY Configuration information
gauthier's avatar
gauthier committed
282 283
 */
void phy_config_dedicated_eNB(module_id_t Mod_id,
knopp's avatar
 
knopp committed
284
                              int CC_id,
285
                              rnti_t rnti,
gauthier's avatar
gauthier committed
286
                              struct PhysicalConfigDedicated *physicalConfigDedicated);
287 288 289 290 291

/*!
\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
gauthier's avatar
gauthier committed
292
 */
293 294 295 296
void phy_config_dedicated_eNB_step2(PHY_VARS_eNB *phy_vars_eNB);

/*
  \fn int phy_init_secsys_eNB(PHY_VARS_eNB *phy_vars_eNb)
297
\brief Allocate and Initialize the PHY variables relevant to the LTE implementation.
298
@param phy_vars_eNb pointer to LTE parameter structure for the eNb
gauthier's avatar
gauthier committed
299
 */
300 301 302 303 304 305 306
int phy_init_secsys_eNB(PHY_VARS_eNB *phy_vars_eNb);


void phy_init_lte_top(LTE_DL_FRAME_PARMS *lte_frame_parms);

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

307 308
void lte_param_init(unsigned char N_tx_port_eNB,
		    unsigned char N_tx, 
309 310 311 312 313 314 315 316 317 318 319
		    unsigned char N_rx,
		    unsigned char transmission_mode,
		    uint8_t extended_prefix_flag,
		    frame_t frame_type, 
		    uint16_t Nid_cell,
		    uint8_t tdd_config,
		    uint8_t N_RB_DL,
		    uint8_t threequarter_fs,
                    uint8_t osf,
		    uint32_t perfect_ce);

320 321
#ifdef Rel10
void phy_config_dedicated_scell_ue(uint8_t Mod_id,
322 323 324
                                   uint8_t eNB_index,
                                   SCellToAddMod_r10_t *sCellToAddMod_r10,
                                   int CC_id);
325 326

void phy_config_dedicated_scell_eNB(uint8_t Mod_id,
327 328 329
                                    uint16_t rnti,
                                    SCellToAddMod_r10_t *sCellToAddMod_r10,
                                    int CC_id);
330

331
#endif
332

333 334 335


/*! !\fn void phy_cleanup(void)
336
\brief Cleanup the PHY variables*/
337 338
void phy_cleanup(void);

339

gauthier's avatar
gauthier committed
340
int init_frame_parms(LTE_DL_FRAME_PARMS *frame_parms,uint8_t osf);
341
void dump_frame_parms(LTE_DL_FRAME_PARMS *frame_parms);
342

Florian Kaltenberger's avatar
Florian Kaltenberger committed
343 344
void lte_param_init(unsigned char N_tx_port_eNB, 
                    unsigned char N_tx_phy,
345 346 347 348 349 350 351 352 353 354
		    unsigned char N_rx,
		    unsigned char transmission_mode,
		    uint8_t extended_prefix_flag,
		    frame_t frame_type, 
		    uint16_t Nid_cell,
		    uint8_t tdd_config,
		    uint8_t N_RB_DL,
		    uint8_t threequarter_fs,
                    uint8_t osf,
		    uint32_t perfect_ce);
355 356 357
/** @} */
#endif