impl_defs_lte.h 48.6 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
 */
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

/*! \file PHY/impl_defs_lte.h
* \brief LTE Physical channel configuration and variable structure definitions
* \author R. Knopp, F. Kaltenberger
* \date 2011
* \version 0.1
* \company Eurecom
* \email: knopp@eurecom.fr,florian.kaltenberger@eurecom.fr
* \note
* \warning
*/

#ifndef __PHY_IMPLEMENTATION_DEFS_LTE_H__
#define __PHY_IMPLEMENTATION_DEFS_LTE_H__


#include "types.h"
//#include "defs.h"

Bilel's avatar
Bilel committed
40 41 42
#define RX_NB_TH_MAX 2
#define RX_NB_TH 2

43 44 45 46
#define LTE_NUMBER_OF_SUBFRAMES_PER_FRAME 10
#define LTE_SLOTS_PER_FRAME  20
#define LTE_CE_FILTER_LENGTH 5
#define LTE_CE_OFFSET LTE_CE_FILTER_LENGTH
47
#define TX_RX_SWITCH_SYMBOL (NUMBER_OF_SYMBOLS_PER_FRAME>>1)
48 49 50 51 52 53 54 55 56 57 58 59
#define PBCH_PDU_SIZE 3 //bytes

#define PRACH_SYMBOL 3 //position of the UL PSS wrt 2nd slot of special subframe

#define NUMBER_OF_FREQUENCY_GROUPS (lte_frame_parms->N_RB_DL)

#define SSS_AMP 1148

#define MAX_NUM_PHICH_GROUPS 56  //110 RBs Ng=2, p.60 36-212, Sec. 6.9

#define MAX_MBSFN_AREA 8

laurent's avatar
laurent committed
60 61 62
#ifdef OCP_FRAMEWORK
#include "enums.h"
#else
63 64 65 66
typedef enum {TDD=1,FDD=0} lte_frame_type_t;

typedef enum {EXTENDED=1,NORMAL=0} lte_prefix_type_t;

67 68
typedef enum {LOCALIZED=0,DISTRIBUTED=1} vrb_t;

69
/// Enumeration for parameter PHICH-Duration \ref PHICH_CONFIG_COMMON::phich_duration.
70 71 72 73 74
typedef enum {
  normal=0,
  extended=1
} PHICH_DURATION_t;

75
/// Enumeration for parameter Ng \ref PHICH_CONFIG_COMMON::phich_resource.
76 77 78 79 80 81
typedef enum {
  oneSixth=1,
  half=3,
  one=6,
  two=12
} PHICH_RESOURCE_t;
laurent's avatar
laurent committed
82
#endif
83
/// PHICH-Config from 36.331 RRC spec
84
typedef struct {
85
  /// Parameter: PHICH-Duration, see TS 36.211 (Table 6.9.3-1).
86
  PHICH_DURATION_t phich_duration;
87
  /// Parameter: Ng, see TS 36.211 (6.9). \details Value oneSixth corresponds to 1/6, half corresponds to 1/2 and so on.
88 89 90
  PHICH_RESOURCE_t phich_resource;
} PHICH_CONFIG_COMMON;

91
/// PRACH-ConfigInfo from 36.331 RRC spec
92
typedef struct {
93
  /// Parameter: prach-ConfigurationIndex, see TS 36.211 (5.7.1). \vr{[0..63]}
94
  uint8_t prach_ConfigIndex;
95
  /// Parameter: High-speed-flag, see TS 36.211 (5.7.2). \vr{[0..1]} 1 corresponds to Restricted set and 0 to Unrestricted set.
96
  uint8_t highSpeedFlag;
97
  /// Parameter: \f$N_\text{CS}\f$, see TS 36.211 (5.7.2). \vr{[0..15]}\n Refer to table 5.7.2-2 for preamble format 0..3 and to table 5.7.2-3 for preamble format 4.
98
  uint8_t zeroCorrelationZoneConfig;
99
  /// Parameter: prach-FrequencyOffset, see TS 36.211 (5.7.1). \vr{[0..94]}\n For TDD the value range is dependent on the value of \ref prach_ConfigIndex.
100
  uint8_t prach_FreqOffset;
101 102
} PRACH_CONFIG_INFO;

103
/// PRACH-ConfigSIB or PRACH-Config from 36.331 RRC spec
104
typedef struct {
105
  /// Parameter: RACH_ROOT_SEQUENCE, see TS 36.211 (5.7.1). \vr{[0..837]}
106
  uint16_t rootSequenceIndex;
107
  /// prach_Config_enabled=1 means enabled. \vr{[0..1]}
108
  uint8_t prach_Config_enabled;
109
  /// PRACH Configuration Information
110 111 112
  PRACH_CONFIG_INFO prach_ConfigInfo;
} PRACH_CONFIG_COMMON;

113
/// Enumeration for parameter \f$N_\text{ANRep}\f$ \ref PUCCH_CONFIG_DEDICATED::repetitionFactor.
114 115 116 117 118 119
typedef enum {
  n2=0,
  n4,
  n6
} ACKNAKREP_t;

120
/// Enumeration for \ref PUCCH_CONFIG_DEDICATED::tdd_AckNackFeedbackMode.
121 122 123 124 125
typedef enum {
  bundling=0,
  multiplexing
} ANFBmode_t;

126
/// PUCCH-ConfigDedicated from 36.331 RRC spec
127
typedef struct {
128
  /// Flag to indicate ACK NAK repetition activation, see TS 36.213 (10.1). \vr{[0..1]}
129
  uint8_t ackNackRepetition;
130
  /// Parameter: \f$N_\text{ANRep}\f$, see TS 36.213 (10.1).
131
  ACKNAKREP_t repetitionFactor;
132
  /// Parameter: \f$n^{(1)}_\text{PUCCH,ANRep}\f$, see TS 36.213 (10.1). \vr{[0..2047]}
133
  uint16_t n1PUCCH_AN_Rep;
134
  /// Feedback mode, see TS 36.213 (7.3). \details Applied to both PUCCH and PUSCH feedback. For TDD, should always be set to bundling.
135 136 137 138 139
  ANFBmode_t tdd_AckNackFeedbackMode;
} PUCCH_CONFIG_DEDICATED;

/// PUCCH-ConfigCommon from 36.331 RRC spec
typedef struct {
140
  /// Parameter: \f$\Delta^\text{PUCCH}_\text{shift}\f$, see TS 36.211 (5.4.1). \vr{[1..3]} \note the specification sais it is an enumerated value.
141
  uint8_t deltaPUCCH_Shift;
142
  /// Parameter: \f$N^{(2)}_\text{RB}\f$, see TS 36.211 (5.4). \vr{[0..98]}
143
  uint8_t nRB_CQI;
144
  /// Parameter: \f$N^{(1)}_\text{CS}\f$, see TS 36.211 (5.4). \vr{[0..7]}
145
  uint8_t nCS_AN;
146
  /// Parameter: \f$N^{(1)}_\text{PUCCH}\f$ see TS 36.213 (10.1). \vr{[0..2047]}
147
  uint16_t n1PUCCH_AN;
fnabet's avatar
fnabet committed
148 149 150 151 152

  /// group hopping sequence for DRS \note not part of offical UL-PUCCH_CONFIG_COMMON ASN1 specification.
  uint8_t grouphop[20];
  /// sequence hopping sequence for DRS \note not part of offical UL-PUCCH_CONFIG_COMMON ASN1 specification.
  uint8_t seqhop[20];
153 154 155 156
} PUCCH_CONFIG_COMMON;

/// UL-ReferenceSignalsPUSCH from 36.331 RRC spec
typedef struct {
157
  /// Parameter: Group-hopping-enabled, see TS 36.211 (5.5.1.3). \vr{[0..1]}
158
  uint8_t groupHoppingEnabled;
159
  /// Parameter: \f$\Delta SS\f$, see TS 36.211 (5.5.1.3). \vr{[0..29]}
160
  uint8_t groupAssignmentPUSCH;
161
  /// Parameter: Sequence-hopping-enabled, see TS 36.211 (5.5.1.4). \vr{[0..1]}
162
  uint8_t sequenceHoppingEnabled;
163
  /// Parameter: cyclicShift, see TS 36.211 (Table 5.5.2.1.1-2). \vr{[0..7]}
164
  uint8_t cyclicShift;
165
  /// nPRS for cyclic shift of DRS \note not part of offical UL-ReferenceSignalsPUSCH ASN1 specification.
166
  uint8_t nPRS[20];
167
  /// group hopping sequence for DRS \note not part of offical UL-ReferenceSignalsPUSCH ASN1 specification.
168
  uint8_t grouphop[20];
169
  /// sequence hopping sequence for DRS \note not part of offical UL-ReferenceSignalsPUSCH ASN1 specification.
170
  uint8_t seqhop[20];
171
} UL_REFERENCE_SIGNALS_PUSCH_t;
172

173
/// Enumeration for parameter Hopping-mode \ref PUSCH_CONFIG_COMMON::hoppingMode.
laurent's avatar
laurent committed
174
#ifndef OCP_FRAMEWORK
175
typedef enum {
176
  interSubFrame=0,
177 178
  intraAndInterSubFrame=1
} PUSCH_HOPPING_t;
laurent's avatar
laurent committed
179
#endif
180

181
/// PUSCH-ConfigCommon from 36.331 RRC spec.
182
typedef struct {
183
  /// Parameter: \f$N_{sb}\f$, see TS 36.211 (5.3.4). \vr{[1..4]}
184
  uint8_t n_SB;
185
  /// Parameter: Hopping-mode, see TS 36.211 (5.3.4).
186
  PUSCH_HOPPING_t hoppingMode;
187
  /// Parameter: \f$N^{HO}_{RB}\f$, see TS 36.211 (5.3.4). \vr{[0..98]}
188
  uint8_t pusch_HoppingOffset;
189
  /// See TS 36.213 (8.6.1). \vr{[0..1]} 1 indicates 64QAM is allowed, 0 not allowed.
190
  uint8_t enable64QAM;
191 192 193 194
  /// Ref signals configuration
  UL_REFERENCE_SIGNALS_PUSCH_t ul_ReferenceSignalsPUSCH;
} PUSCH_CONFIG_COMMON;

195
/// UE specific PUSCH configuration.
196
typedef struct {
197
  /// Parameter: \f$I^\text{HARQ-ACK}_\text{offset}\f$, see TS 36.213 (Table 8.6.3-1). \vr{[0..15]}
198
  uint16_t betaOffset_ACK_Index;
199
  /// Parameter: \f$I^{RI}_\text{offset}\f$, see TS 36.213 (Table 8.6.3-2). \vr{[0..15]}
200
  uint16_t betaOffset_RI_Index;
201
  /// Parameter: \f$I^{CQI}_\text{offset}\f$, see TS 36.213 (Table 8.6.3-3). \vr{[0..15]}
202
  uint16_t betaOffset_CQI_Index;
203 204
} PUSCH_CONFIG_DEDICATED;

205
/// lola CBA information
206
typedef struct {
207
  ///
208
  uint16_t betaOffset_CA_Index;
209
  ///
210
  uint16_t cShift;
211 212 213 214
} PUSCH_CA_CONFIG_DEDICATED;

/// PDSCH-ConfigCommon from 36.331 RRC spec
typedef struct {
215
  /// Parameter: Reference-signal power, see TS 36.213 (5.2). \vr{[-60..50]}\n Provides the downlink reference-signal EPRE. The actual value in dBm.
216
  int8_t referenceSignalPower;
217
  /// Parameter: \f$P_B\f$, see TS 36.213 (Table 5.2-1). \vr{[0..3]}
218
  uint8_t p_b;
219 220
} PDSCH_CONFIG_COMMON;

221
/// Enumeration for Parameter \f$P_A\f$ \ref PDSCH_CONFIG_DEDICATED::p_a.
222
typedef enum {
223 224 225 226 227 228 229 230
  dBm6=0, ///< (dB-6) corresponds to -6 dB
  dBm477, ///< (dB-4dot77) corresponds to -4.77 dB
  dBm3,   ///< (dB-3) corresponds to -3 dB
  dBm177, ///< (dB-1dot77) corresponds to -1.77 dB
  dB0,    ///< corresponds to 0 dB
  dB1,    ///< corresponds to 1 dB
  dB2,    ///< corresponds to 2 dB
  dB3     ///< corresponds to 3 dB
231 232
} PA_t;

233
/// PDSCH-ConfigDedicated from 36.331 RRC spec
234
typedef struct {
235 236
  /// Parameter: \f$P_A\f$, see TS 36.213 (5.2).
  PA_t p_a;
237 238 239 240
} PDSCH_CONFIG_DEDICATED;

/// SoundingRS-UL-ConfigCommon Information Element from 36.331 RRC spec
typedef struct {
241
  /// enabled flag=1 means SRS is enabled. \vr{[0..1]}
242
  uint8_t enabled_flag;
243
  /// Parameter: SRS Bandwidth Configuration, see TS 36.211 (table 5.5.3.2-1, 5.5.3.2-2, 5.5.3.2-3 and 5.5.3.2-4). \vr{[0..7]}\n Actual configuration depends on UL bandwidth. \note the specification sais it is an enumerated value.
244
  uint8_t srs_BandwidthConfig;
245
  /// Parameter: SRS SubframeConfiguration, see TS 36.211 (table 5.5.3.3-1 for FDD, table 5.5.3.3-2 for TDD). \vr{[0..15]} \note the specification sais it is an enumerated value.
246
  uint8_t srs_SubframeConfig;
247
  /// Parameter: Simultaneous-AN-and-SRS, see TS 36.213 (8.2). \vr{[0..1]}
248
  uint8_t ackNackSRS_SimultaneousTransmission;
249
  /// Parameter: srsMaxUpPts, see TS 36.211 (5.5.3.2). \details If this field is present, reconfiguration of \f$m^\text{max}_\text{SRS,0}\f$ applies for UpPts, otherwise reconfiguration does not apply.
250
  uint8_t srs_MaxUpPts;
251 252
} SOUNDINGRS_UL_CONFIG_COMMON;

253
/// \note UNUSED
254 255 256 257 258 259 260 261 262 263 264
typedef enum {
  ulpc_al0=0,
  ulpc_al04=1,
  ulpc_al05=2,
  ulpc_al06=3,
  ulpc_al07=4,
  ulpc_al08=5,
  ulpc_al09=6,
  ulpc_al11=7
} UL_POWER_CONTROL_COMMON_alpha_t;

265
/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format1.
266
typedef enum {
267 268 269
  deltaF_PUCCH_Format1_deltaF_2  = 0,
  deltaF_PUCCH_Format1_deltaF0   = 1,
  deltaF_PUCCH_Format1_deltaF2   = 2
270
} deltaF_PUCCH_Format1_t;
271 272

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format1b.
273
typedef enum {
274 275 276
  deltaF_PUCCH_Format1b_deltaF1  = 0,
  deltaF_PUCCH_Format1b_deltaF3  = 1,
  deltaF_PUCCH_Format1b_deltaF5  = 2
277
} deltaF_PUCCH_Format1b_t;
278 279

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2.
280
typedef enum {
281 282 283 284
  deltaF_PUCCH_Format2_deltaF_2  = 0,
  deltaF_PUCCH_Format2_deltaF0   = 1,
  deltaF_PUCCH_Format2_deltaF1   = 2,
  deltaF_PUCCH_Format2_deltaF2   = 3
285
} deltaF_PUCCH_Format2_t;
286 287

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2a.
288
typedef enum {
289 290 291
  deltaF_PUCCH_Format2a_deltaF_2 = 0,
  deltaF_PUCCH_Format2a_deltaF0  = 1,
  deltaF_PUCCH_Format2a_deltaF2  = 2
292
} deltaF_PUCCH_Format2a_t;
293 294

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2b.
295
typedef enum {
296 297 298
  deltaF_PUCCH_Format2b_deltaF_2 = 0,
  deltaF_PUCCH_Format2b_deltaF0  = 1,
  deltaF_PUCCH_Format2b_deltaF2  = 2
299 300
} deltaF_PUCCH_Format2b_t;

301
/// DeltaFList-PUCCH from 36.331 RRC spec
302
typedef struct {
303 304 305 306 307
  deltaF_PUCCH_Format1_t   deltaF_PUCCH_Format1;
  deltaF_PUCCH_Format1b_t  deltaF_PUCCH_Format1b;
  deltaF_PUCCH_Format2_t   deltaF_PUCCH_Format2;
  deltaF_PUCCH_Format2a_t  deltaF_PUCCH_Format2a;
  deltaF_PUCCH_Format2b_t  deltaF_PUCCH_Format2b;
308 309 310 311
} deltaFList_PUCCH_t;

/// SoundingRS-UL-ConfigDedicated Information Element from 36.331 RRC spec
typedef struct {
312
  /// Parameter: \f$B_\text{SRS}\f$, see TS 36.211 (table 5.5.3.2-1, 5.5.3.2-2, 5.5.3.2-3 and 5.5.3.2-4). \vr{[0..3]} \note the specification sais it is an enumerated value.
313
  uint8_t srs_Bandwidth;
314
  /// Parameter: SRS hopping bandwidth \f$b_\text{hop}\in\{0,1,2,3\}\f$, see TS 36.211 (5.5.3.2) \vr{[0..3]} \note the specification sais it is an enumerated value.
315
  uint8_t srs_HoppingBandwidth;
316
  /// Parameter: \f$n_\text{RRC}\f$, see TS 36.211 (5.5.3.2). \vr{[0..23]}
317
  uint8_t freqDomainPosition;
318
  /// Parameter: Duration, see TS 36.213 (8.2). \vr{[0..1]} 0 corresponds to "single" and 1 to "indefinite".
319
  uint8_t duration;
320
  /// Parameter: \f$k_\text{TC}\in\{0,1\}\f$, see TS 36.211 (5.5.3.2). \vr{[0..1]}
321
  uint8_t transmissionComb;
322
  /// Parameter: \f$I_\text{SRS}\f$, see TS 36.213 (table 8.2-1). \vr{[0..1023]}
323
  uint16_t srs_ConfigIndex;
324
  /// Parameter: \f$n^\text{CS}_\text{SRS}\f$. See TS 36.211 (5.5.3.1). \vr{[0..7]} \note the specification sais it is an enumerated value.
325
  uint8_t cyclicShift;
326
  // Parameter: internal implementation: UE SRS configured
fnabet's avatar
fnabet committed
327
  uint8_t srsConfigDedicatedSetup;
Bilel's avatar
Bilel committed
328 329 330 331
  // Parameter: cell srs subframe for internal implementation
  uint8_t srsCellSubframe;
  // Parameter: ue srs subframe for internal implementation
  uint8_t srsUeSubframe;
332 333
} SOUNDINGRS_UL_CONFIG_DEDICATED;

334
/// UplinkPowerControlDedicated Information Element from 36.331 RRC spec
335
typedef struct {
336
  /// Parameter: \f$P_\text{0\_UE\_PUSCH}(1)\f$, see TS 36.213 (5.1.1.1), unit dB. \vr{[-8..7]}\n This field is applicable for non-persistent scheduling, only.
337
  int8_t p0_UE_PUSCH;
338
  /// Parameter: Ks, see TS 36.213 (5.1.1.1). \vr{[0..1]}\n en0 corresponds to value 0 corresponding to state “disabled”. en1 corresponds to value 1.25 corresponding to “enabled”. \note the specification sais it is an enumerated value. \warning the enumeration values do not correspond to the given values in the specification (en1 should be 1.25).
339
  uint8_t deltaMCS_Enabled;
340
  /// Parameter: Accumulation-enabled, see TS 36.213 (5.1.1.1). \vr{[0..1]} 1 corresponds to "enabled" whereas 0 corresponds to "disabled".
341
  uint8_t accumulationEnabled;
342
  /// Parameter: \f$P_\text{0\_UE\_PUCCH}(1)\f$, see TS 36.213 (5.1.2.1), unit dB. \vr{[-8..7]}
343
  int8_t p0_UE_PUCCH;
344
  /// Parameter: \f$P_\text{SRS\_OFFSET}\f$, see TS 36.213 (5.1.3.1). \vr{[0..15]}\n For Ks=1.25 (\ref deltaMCS_Enabled), the actual parameter value is pSRS_Offset value - 3. For Ks=0, the actual parameter value is -10.5 + 1.5*pSRS_Offset value.
345
  int8_t pSRS_Offset;
346
  /// Specifies the filtering coefficient for RSRP measurements used to calculate path loss, as specified in TS 36.213 (5.1.1.1).\details The same filtering mechanism applies as for quantityConfig described in 5.5.3.2. \note the specification sais it is an enumerated value.
347
  uint8_t filterCoefficient;
348 349
} UL_POWER_CONTROL_DEDICATED;

laurent's avatar
laurent committed
350
#ifndef OCP_FRAMEWORK
351
/// Enumeration for parameter \f$\alpha\f$ \ref UL_POWER_CONTROL_CONFIG_COMMON::alpha.
352 353 354 355 356 357 358 359 360 361
typedef enum {
  al0=0,
  al04=1,
  al05=2,
  al06=3,
  al07=4,
  al08=5,
  al09=6,
  al1=7
} PUSCH_alpha_t;
laurent's avatar
laurent committed
362
#endif
363

364
/// \note UNUSED
365 366 367 368 369 370
typedef enum {
  deltaFm2=0,
  deltaF0,
  deltaF1,
  deltaF2,
  deltaF3,
371
  deltaF5
372 373
} deltaF_PUCCH_t;

374
/// UplinkPowerControlCommon Information Element from 36.331 RRC spec \note this structure does not currently make use of \ref deltaFList_PUCCH_t.
375
typedef struct {
376
  /// Parameter: \f$P_\text{0\_NOMINAL\_PUSCH}(1)\f$, see TS 36.213 (5.1.1.1), unit dBm. \vr{[-126..24]}\n This field is applicable for non-persistent scheduling, only.
377
  int8_t p0_NominalPUSCH;
378
  /// Parameter: \f$\alpha\f$, see TS 36.213 (5.1.1.1) \warning the enumeration values do not correspond to the given values in the specification (al04 should be 0.4, ...)!
379
  PUSCH_alpha_t alpha;
380
  /// Parameter: \f$P_\text{0\_NOMINAL\_PUCCH}\f$ See TS 36.213 (5.1.2.1), unit dBm. \vr{[-127..-96]}
381
  int8_t p0_NominalPUCCH;
382
  /// Parameter: \f$\Delta_\text{PREAMBLE\_Msg3}\f$ see TS 36.213 (5.1.1.1). \vr{[-1..6]}\n Actual value = IE value * 2 [dB].
383
  int8_t deltaPreambleMsg3;
384
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 1, see TS 36.213 (5.1.2). \vr{[0..2]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
385
  long deltaF_PUCCH_Format1;
386
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 1a, see TS 36.213 (5.1.2). \vr{[0..2]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
387
  long deltaF_PUCCH_Format1a;
388
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 1b, see TS 36.213 (5.1.2). \vr{[0..2]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
389
  long deltaF_PUCCH_Format1b;
390
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 2, see TS 36.213 (5.1.2). \vr{[0..3]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
391
  long deltaF_PUCCH_Format2;
392
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 2a, see TS 36.213 (5.1.2). \vr{[0..2]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
393
  long deltaF_PUCCH_Format2a;
394
  /// Parameter: \f$\Delta_\text{F\_PUCCH}(F)\f$ for the PUCCH format 2b, see TS 36.213 (5.1.2). \vr{[0..2]} \warning check value range, why is this a long? \note the specification sais it is an enumerated value.
395 396 397
  long deltaF_PUCCH_Format2b;
} UL_POWER_CONTROL_CONFIG_COMMON;

398
/// Union for \ref TPC_PDCCH_CONFIG::tpc_Index.
399
typedef union {
400 401 402 403
  /// Index of N when DCI format 3 is used. See TS 36.212 (5.3.3.1.6). \vr{[1..15]}
  uint8_t indexOfFormat3;
  /// Index of M when DCI format 3A is used. See TS 36.212 (5.3.3.1.7). \vr{[1..31]}
  uint8_t indexOfFormat3A;
404 405
} TPC_INDEX_t;

406
/// TPC-PDCCH-Config Information Element from 36.331 RRC spec
407
typedef struct {
408
  /// RNTI for power control using DCI format 3/3A, see TS 36.212. \vr{[0..65535]}
409
  uint16_t rnti;
410
  /// Index of N or M, see TS 36.212 (5.3.3.1.6 and 5.3.3.1.7), where N or M is dependent on the used DCI format (i.e. format 3 or 3a).
411 412 413
  TPC_INDEX_t tpc_Index;
} TPC_PDCCH_CONFIG;

414
/// Enumeration for parameter SR transmission \ref SCHEDULING_REQUEST_CONFIG::dsr_TransMax.
415 416 417 418 419 420 421 422
typedef enum {
  sr_n4=0,
  sr_n8=1,
  sr_n16=2,
  sr_n32=3,
  sr_n64=4
} DSR_TRANSMAX_t;

423
/// SchedulingRequestConfig Information Element from 36.331 RRC spec
424
typedef struct {
425
  /// Parameter: \f$n^{(1)}_\text{PUCCH,SRI}\f$, see TS 36.213 (10.1). \vr{[0..2047]}
426
  uint16_t sr_PUCCH_ResourceIndex;
427
  /// Parameter: \f$I_\text{SR}\f$, see TS 36.213 (10.1). \vr{[0..155]}
428
  uint8_t sr_ConfigIndex;
429
  /// Parameter for SR transmission in TS 36.321 (5.4.4). \details The value n4 corresponds to 4 transmissions, n8 corresponds to 8 transmissions and so on.
430 431 432
  DSR_TRANSMAX_t dsr_TransMax;
} SCHEDULING_REQUEST_CONFIG;

433
/// CQI-ReportPeriodic
434
typedef struct {
knopp's avatar
knopp committed
435 436
  /// Parameter: \f$n^{(2)}_\text{PUCCH}\f$, see TS 36.213 (7.2). \vr{[0..1185]}, -1 indicates inactivity
  int16_t cqi_PUCCH_ResourceIndex;
437
  /// Parameter: CQI/PMI Periodicity and Offset Configuration Index \f$I_\text{CQI/PMI}\f$, see TS 36.213 (tables 7.2.2-1A and 7.2.2-1C). \vr{[0..1023]}
knopp's avatar
knopp committed
438
  int16_t cqi_PMI_ConfigIndex;
439
  /// Parameter: K, see 36.213 (4.2.2). \vr{[1..4]}
440
  uint8_t K;
knopp's avatar
knopp committed
441 442
  /// Parameter: RI Config Index \f$I_\text{RI}\f$, see TS 36.213 (7.2.2-1B). \vr{[0..1023]}, -1 indicates inactivity
  int16_t ri_ConfigIndex;
443
  /// Parameter: Simultaneous-AN-and-CQI, see TS 36.213 (10.1). \vr{[0..1]} 1 indicates that simultaneous transmission of ACK/NACK and CQI is allowed.
444
  uint8_t simultaneousAckNackAndCQI;
knopp's avatar
knopp committed
445 446 447 448
  /// parameter computed from Tables 7.2.2-1A and 7.2.2-1C
  uint16_t Npd;
  /// parameter computed from Tables 7.2.2-1A and 7.2.2-1C
  uint16_t N_OFFSET_CQI;
449 450
} CQI_REPORTPERIODIC;

451 452 453 454 455 456 457 458 459 460
/// Enumeration for parameter reporting mode \ref CQI_REPORT_CONFIG::cqi_ReportModeAperiodic.
typedef enum {
  rm12=0,
  rm20=1,
  rm22=2,
  rm30=3,
  rm31=4
} CQI_REPORTMODEAPERIODIC;

/// CQI-ReportConfig Information Element from 36.331 RRC spec
461
typedef struct {
462
  /// Parameter: reporting mode. Value rm12 corresponds to Mode 1-2, rm20 corresponds to Mode 2-0, rm22 corresponds to Mode 2-2 etc. PUSCH reporting modes are described in TS 36.213 [23, 7.2.1].
463
  CQI_REPORTMODEAPERIODIC cqi_ReportModeAperiodic;
464
  /// Parameter: \f$\Delta_\text{offset}\f$, see TS 36.213 (7.2.3). \vr{[-1..6]}\n Actual value = IE value * 2 [dB].
465
  int8_t nomPDSCH_RS_EPRE_Offset;
466 467 468
  CQI_REPORTPERIODIC CQI_ReportPeriodic;
} CQI_REPORT_CONFIG;

469
/// MBSFN-SubframeConfig Information Element from 36.331 RRC spec \note deviates from specification.
470
typedef struct {
471
  /// MBSFN subframe occurance. \details Radio-frames that contain MBSFN subframes occur when equation SFN mod radioFrameAllocationPeriod = radioFrameAllocationOffset is satisfied. When fourFrames is used for subframeAllocation, the equation defines the first radio frame referred to in the description below. Values n1 and n2 are not applicable when fourFrames is used. \note the specification sais it is an enumerated value {n1, n2, n4, n8, n16, n32}.
472
  int radioframeAllocationPeriod;
473
  /// MBSFN subframe occurance. \vr{[0..7]}\n Radio-frames that contain MBSFN subframes occur when equation SFN mod radioFrameAllocationPeriod = radioFrameAllocationOffset is satisfied. When fourFrames is used for subframeAllocation, the equation defines the first radio frame referred to in the description below. Values n1 and n2 are not applicable when fourFrames is used.
474
  int radioframeAllocationOffset;
475
  /// oneFrame or fourFrames. \vr{[0..1]}
476
  int fourFrames_flag;
477 478 479 480 481
  /// Subframe configuration. \vr{[0..63]} (\ref fourFrames_flag == 0) or \vr{[0..16777215]} (\ref fourFrames_flag == 1)
  /// \par fourFrames_flag == 0
  /// "1" denotes that the corresponding subframe is allocated for MBSFN. The following mapping applies:\n FDD: The first/leftmost bit defines the MBSFN allocation for subframe #1, the second bit for #2, third bit for #3 , fourth bit for #6, fifth bit for #7, sixth bit for #8.\n TDD: The first/leftmost bit defines the allocation for subframe #3, the second bit for #4, third bit for #7, fourth bit for #8, fifth bit for #9. Uplink subframes are not allocated. The last bit is not used.
  /// \par fourFrames_flag == 1
  /// A bit-map indicating MBSFN subframe allocation in four consecutive radio frames, "1" denotes that the corresponding subframe is allocated for MBSFN. The bitmap is interpreted as follows:\n FDD: Starting from the first radioframe and from the first/leftmost bit in the bitmap, the allocation applies to subframes #1, #2, #3 , #6, #7, and #8 in the sequence of the four radio-frames.\n TDD: Starting from the first radioframe and from the first/leftmost bit in the bitmap, the allocation applies to subframes #3, #4, #7, #8, and #9 in the sequence of the four radio-frames. The last four bits are not used. Uplink subframes are not allocated.
482 483 484 485 486
  int mbsfn_SubframeConfig;
} MBSFN_config_t;

typedef struct {
  /// Number of resource blocks (RB) in DL
487
  uint8_t N_RB_DL;
488
  /// Number of resource blocks (RB) in UL
489
  uint8_t N_RB_UL;
490 491 492
  ///  total Number of Resource Block Groups: this is ceil(N_PRB/P)
  uint8_t N_RBG;
  /// Total Number of Resource Block Groups SubSets: this is P
493
  uint8_t N_RBGS;
494
  /// Cell ID
495
  uint16_t Nid_cell;
496
  /// MBSFN Area ID
497
  uint16_t Nid_cell_mbsfn;
498 499 500
  /// Cyclic Prefix for DL (0=Normal CP, 1=Extended CP)
  lte_prefix_type_t Ncp;
  /// Cyclic Prefix for UL (0=Normal CP, 1=Extended CP)
501
  lte_prefix_type_t Ncp_UL;
502
  /// shift of pilot position in one RB
503
  uint8_t nushift;
504 505 506
  /// Frame type (0 FDD, 1 TDD)
  lte_frame_type_t frame_type;
  /// TDD subframe assignment (0-7) (default = 3) (254=RX only, 255=TX only)
507
  uint8_t tdd_config;
508
  /// TDD S-subframe configuration (0-9)
509
  uint8_t tdd_config_S;
510 511
  /// srs extra symbol flag for TDD
  uint8_t srsX;
512
  /// indicates if node is a UE (NODE=2) or eNB (PRIMARY_CH=0).
513
  uint8_t node_id;
514
  /// Frequency index of CBMIMO1 card
515
  uint8_t freq_idx;
516
  /// RX Frequency for ExpressMIMO/LIME
517
  uint32_t carrier_freq[4];
518
  /// TX Frequency for ExpressMIMO/LIME
519
  uint32_t carrier_freqtx[4];
520
  /// RX gain for ExpressMIMO/LIME
521
  uint32_t rxgain[4];
522
  /// TX gain for ExpressMIMO/LIME
523
  uint32_t txgain[4];
524
  /// RF mode for ExpressMIMO/LIME
525
  uint32_t rfmode[4];
526
  /// RF RX DC Calibration for ExpressMIMO/LIME
527
  uint32_t rxdc[4];
528
  /// RF TX DC Calibration for ExpressMIMO/LIME
529
  uint32_t rflocal[4];
530
  /// RF VCO calibration for ExpressMIMO/LIME
531
  uint32_t rfvcolocal[4];
532
  /// Turns on second TX of CBMIMO1 card
533
  uint8_t dual_tx;
534
  /// flag to indicate SISO transmission
535
  uint8_t mode1_flag;
536 537
  /// Indicator that 20 MHz channel uses 3/4 sampling frequency
  uint8_t threequarter_fs;
538
  /// Size of FFT
539
  uint16_t ofdm_symbol_size;
540
  /// Number of prefix samples in all but first symbol of slot
541
  uint16_t nb_prefix_samples;
542
  /// Number of prefix samples in first symbol of slot
543
  uint16_t nb_prefix_samples0;
544
  /// Carrier offset in FFT buffer for first RE in PRB0
545
  uint16_t first_carrier_offset;
546
  /// Number of samples in a subframe
547
  uint32_t samples_per_tti;
548
  /// Number of OFDM/SC-FDMA symbols in one subframe (to be modified to account for potential different in UL/DL)
549
  uint16_t symbols_per_tti;
550 551 552 553
  /// Number of OFDM symbols in DL portion of S-subframe
  uint16_t dl_symbols_in_S_subframe;
  /// Number of SC-FDMA symbols in UL portion of S-subframe
  uint16_t ul_symbols_in_S_subframe;
Xiwen JIANG's avatar
Xiwen JIANG committed
554
  /// Number of Physical transmit antennas in node
555
  uint8_t nb_antennas_tx;
556
  /// Number of Receive antennas in node
557
  uint8_t nb_antennas_rx;
558
  /// Number of common transmit antenna ports in eNodeB (1 or 2)
Xiwen JIANG's avatar
Xiwen JIANG committed
559
  uint8_t nb_antenna_ports_eNB;
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
  /// PRACH_CONFIG
  PRACH_CONFIG_COMMON prach_config_common;
  /// PUCCH Config Common (from 36-331 RRC spec)
  PUCCH_CONFIG_COMMON pucch_config_common;
  /// PDSCH Config Common (from 36-331 RRC spec)
  PDSCH_CONFIG_COMMON pdsch_config_common;
  /// PUSCH Config Common (from 36-331 RRC spec)
  PUSCH_CONFIG_COMMON pusch_config_common;
  /// PHICH Config (from 36-331 RRC spec)
  PHICH_CONFIG_COMMON phich_config_common;
  /// SRS Config (from 36-331 RRC spec)
  SOUNDINGRS_UL_CONFIG_COMMON soundingrs_ul_config_common;
  /// UL Power Control (from 36-331 RRC spec)
  UL_POWER_CONTROL_CONFIG_COMMON ul_power_control_config_common;
  /// Number of MBSFN Configurations
  int num_MBSFN_config;
576
  /// Array of MBSFN Configurations (max 8 (maxMBSFN-Allocations) elements as per 36.331)
577 578
  MBSFN_config_t MBSFN_config[8];
  /// Maximum Number of Retransmissions of RRCConnectionRequest (from 36-331 RRC Spec)
579
  uint8_t maxHARQ_Msg3Tx;
580
  /// Size of SI windows used for repetition of one SI message (in frames)
581
  uint8_t SIwindowsize;
582
  /// Period of SI windows used for repetition of one SI message (in frames)
583
  uint16_t SIPeriod;
584
  /// REGs assigned to PCFICH
585
  uint16_t pcfich_reg[4];
586
  /// Index of first REG assigned to PCFICH
587
  uint8_t pcfich_first_reg_idx;
588
  /// REGs assigned to PHICH
589
  uint16_t phich_reg[MAX_NUM_PHICH_GROUPS][3];
590 591 592 593 594 595

  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[MAX_MBSFN_AREA];

} LTE_DL_FRAME_PARMS;

typedef enum {
596
  /// TM1
597
  SISO=0,
598
  /// TM2
599
  ALAMOUTI=1,
600
  /// TM3
601
  LARGE_CDD=2,
602
  /// the next 6 entries are for TM5
603 604 605 606 607 608
  UNIFORM_PRECODING11=3,
  UNIFORM_PRECODING1m1=4,
  UNIFORM_PRECODING1j=5,
  UNIFORM_PRECODING1mj=6,
  PUSCH_PRECODING0=7,
  PUSCH_PRECODING1=8,
609
  /// the next 3 entries are for TM4
610 611
  DUALSTREAM_UNIFORM_PRECODING1=9,
  DUALSTREAM_UNIFORM_PRECODINGj=10,
612
  DUALSTREAM_PUSCH_PRECODING=11,
613 614 615
  TM7=12,
  TM8=13,
  TM9_10=14
616 617
} MIMO_mode_t;

618 619 620 621 622 623 624 625 626
typedef enum {
  /// MRT
  MRT=0,
  /// ZF
  ZF=1,
  /// MMSE
  MMSE=2
} PRECODE_TYPE_t;

627
typedef struct {
628 629 630 631 632
  /// \brief Holds the transmit data in time domain.
  /// For IFFT_FPGA this points to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: tx antenna [0..nb_antennas_tx[
  /// - third index:
633
  int32_t **txdata[3];
634
  /// \brief holds the transmit data in the frequency domain.
Xiwen JIANG's avatar
Xiwen JIANG committed
635
  /// For IFFT_FPGA this points to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER. //?
636
  /// - first index: eNB id [0..2] (hard coded)
Xiwen JIANG's avatar
Xiwen JIANG committed
637
  /// - second index: tx antenna [0..14[ where 14 is the total supported antenna ports.
638
  /// - third index: sample [0..]
639
  int32_t **txdataF[3];
Xiwen JIANG's avatar
Xiwen JIANG committed
640 641 642 643 644
  /// \brief holds the transmit data after beamforming in the frequency domain.
  /// For IFFT_FPGA this points to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER. //?
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: tx antenna [0..nb_antennas_tx[
  /// - third index: sample [0..]
645
  int32_t **txdataF_BF[3];
646 647
  /// \brief Holds the received data in time domain.
  /// Should point to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER.
648
  /// - first index: sector id [0..2] (hard coded)
649 650
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..]
651
  int32_t **rxdata[3];
652
  /// \brief Holds the last subframe of received data in time domain after removal of 7.5kHz frequency offset.
653
  /// - first index: secotr id [0..2] (hard coded)
654 655
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..samples_per_tti[
656
  int32_t **rxdata_7_5kHz[3];
657
  /// \brief Holds the received data in the frequency domain.
658
  /// - first index: sector id [0..2] (hard coded)
659 660
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size*frame_parms->symbols_per_tti[
661
  int32_t **rxdataF[3];
662
  /// \brief Holds output of the sync correlator.
663
  /// - first index: sector id [0..2] (hard coded)
664
  /// - second index: sample [0..samples_per_tti*10[
665
  uint32_t *sync_corr[3];
Xiwen JIANG's avatar
Xiwen JIANG committed
666
  /// \brief Holds the beamforming weights
667
  /// - first index: eNB id [0..2] (hard coded)
668
  /// - second index: eNB antenna port index (hard coded)
669 670 671
  /// - third index: tx antenna [0..nb_antennas_tx[
  /// - fourth index: sample [0..]
  int32_t **beam_weights[3][15];
672 673
  /// \brief Holds the tdd reciprocity calibration coefficients
  /// - first index: eNB id [0..2] (hard coded)
674 675
  /// - second index: tx antenna [0..nb_antennas_tx[
  /// - third index: frequency [0..]
676
  int32_t **tdd_calib_coeffs[3];
677 678
} LTE_eNB_COMMON;

679
typedef struct {
680
  /// \brief Hold the channel estimates in frequency domain based on SRS.
681
  /// - first index: sector id [0..2] (hard coded)
682 683
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..ofdm_symbol_size[
684
  int32_t **srs_ch_estimates[3];
685
  /// \brief Hold the channel estimates in time domain based on SRS.
686
  /// - first index: sector id [0..2] (hard coded)
687 688
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size[
689
  int32_t **srs_ch_estimates_time[3];
690 691
  /// \brief Holds the SRS for channel estimation at the RX.
  /// - first index: ? [0..ofdm_symbol_size[
692
  int32_t *srs;
693 694
} LTE_eNB_SRS;

695
typedef struct {
696
  /// \brief Holds the received data in the frequency domain for the allocated RBs in repeated format.
697
  /// - first index: sector id [0..2] (hard coded)
698 699 700 701
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size[
  /// - third index (definition from phy_init_lte_eNB()): ? [0..24*N_RB_UL*frame_parms->symbols_per_tti[
  /// \warning inconsistent third index definition
702
  int32_t **rxdataF_ext[3];
703
  /// \brief Holds the received data in the frequency domain for the allocated RBs in normal format.
704
  /// - first index: sector id [0..2] (hard coded)
705 706
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index (definition from phy_init_lte_eNB()): ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
707
  int32_t **rxdataF_ext2[3];
708
  /// \brief Hold the channel estimates in time domain based on DRS.
709
  /// - first index: sector id [0..2] (hard coded)
710 711
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..4*ofdm_symbol_size[
712
  int32_t **drs_ch_estimates_time[3];
713
  /// \brief Hold the channel estimates in frequency domain based on DRS.
714
  /// - first index: sector id [0..2] (hard coded)
715 716
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
717
  int32_t **drs_ch_estimates[3];
718
  /// \brief Hold the channel estimates for UE0 in case of Distributed Alamouti Scheme.
719
  /// - first index: sector id [0..2] (hard coded)
720 721
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
722
  int32_t **drs_ch_estimates_0[3];
723
  /// \brief Hold the channel estimates for UE1 in case of Distributed Almouti Scheme.
724
  /// - first index: sector id [0..2] (hard coded)
725 726
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
727
  int32_t **drs_ch_estimates_1[3];
728
  /// \brief Holds the compensated signal.
729
  /// - first index: sector id [0..2] (hard coded)
730 731
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
732
  int32_t **rxdataF_comp[3];
733
  /// \brief Hold the compensated data (y)*(h0*) in case of Distributed Alamouti Scheme.
734
  /// - first index: sector id [0..2] (hard coded)
735 736
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
737
  int32_t **rxdataF_comp_0[3];
738
  /// \brief Hold the compensated data (y*)*(h1) in case of Distributed Alamouti Scheme.
739
  /// - first index: sector id [0..2] (hard coded)
740 741
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
742
  int32_t **rxdataF_comp_1[3];
743
  /// \brief ?.
744
  /// - first index: sector id [0..2] (hard coded)
745 746
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
747
  int32_t **ul_ch_mag[3];
748 749 750 751
  /// \brief ?.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
752
  int32_t **ul_ch_magb[3];
753 754 755 756
  /// \brief Hold the channel mag for UE0 in case of Distributed Alamouti Scheme.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
757
  int32_t **ul_ch_mag_0[3];
758 759 760 761
  /// \brief Hold the channel magb for UE0 in case of Distributed Alamouti Scheme.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
762
  int32_t **ul_ch_magb_0[3];
763 764 765 766
  /// \brief Hold the channel mag for UE1 in case of Distributed Alamouti Scheme.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
767
  int32_t **ul_ch_mag_1[3];
768 769 770 771
  /// \brief Hold the channel magb for UE1 in case of Distributed Alamouti Scheme.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..12*N_RB_UL*frame_parms->symbols_per_tti[
772
  int32_t **ul_ch_magb_1[3];
773 774 775 776 777 778
  /// measured RX power based on DRS
  int ulsch_power[2];
  /// measured RX power based on DRS for UE0 in case of Distributed Alamouti Scheme
  int ulsch_power_0[2];
  /// measured RX power based on DRS for UE0 in case of Distributed Alamouti Scheme
  int ulsch_power_1[2];
779 780
  /// \brief llr values.
  /// - first index: ? [0..1179743] (hard coded)
781
  int16_t *llr;
782 783 784 785 786 787
#ifdef LOCALIZATION
  /// number of active subcarrier for a specific UE
  int32_t active_subcarrier;
  /// subcarrier power in dBm
  int32_t *subcarrier_power;
#endif
788 789
} LTE_eNB_PUSCH;

790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
typedef struct {

	  /// \brief Holds the received data in the frequency domain.
	  /// - first index: rx antenna [0..nb_antennas_rx[
	  /// - second index: symbol [0..28*ofdm_symbol_size[
	  int32_t **rxdataF;

	  /// \brief Hold the channel estimates in frequency domain.
	  /// - first index: eNB id [0..6] (hard coded)
	  /// - second index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
	  /// - third index: samples? [0..symbols_per_tti*(ofdm_symbol_size+LTE_CE_FILTER_LENGTH)[
	  int32_t **dl_ch_estimates[7];

	  /// \brief Hold the channel estimates in time domain (used for tracking).
	  /// - first index: eNB id [0..6] (hard coded)
	  /// - second index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
	  /// - third index: samples? [0..2*ofdm_symbol_size[
	  int32_t **dl_ch_estimates_time[7];
}LTE_UE_COMMON_PER_THREAD;

810
typedef struct {
811 812 813 814
  /// \brief Holds the transmit data in time domain.
  /// For IFFT_FPGA this points to the same memory as PHY_vars->tx_vars[a].TX_DMA_BUFFER.
  /// - first index: tx antenna [0..nb_antennas_tx[
  /// - second index: sample [0..FRAME_LENGTH_COMPLEX_SAMPLES[
815
  int32_t **txdata;
816 817 818 819
  /// \brief Holds the transmit data in the frequency domain.
  /// For IFFT_FPGA this points to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER.
  /// - first index: tx antenna [0..nb_antennas_tx[
  /// - second index: sample [0..FRAME_LENGTH_COMPLEX_SAMPLES_NO_PREFIX[
820
  int32_t **txdataF;
821

822 823 824 825
  /// \brief Holds the received data in time domain.
  /// Should point to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: sample [0..FRAME_LENGTH_COMPLEX_SAMPLES+2048[
826
  int32_t **rxdata;
827

Bilel's avatar
Bilel committed
828
  LTE_UE_COMMON_PER_THREAD common_vars_rx_data_per_thread[RX_NB_TH_MAX];
829

830
  /// holds output of the sync correlator
831
  int32_t *sync_corr;
832
  /// estimated frequency offset (in radians) for all subcarriers
833
  int32_t freq_offset;
834
  /// eNb_id user is synched to
835
  int32_t eNb_id;
836 837 838
} LTE_UE_COMMON;

typedef struct {
839 840 841
  /// \brief Received frequency-domain signal after extraction.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
842
  int32_t **rxdataF_ext;
843 844 845 846
  /// \brief Received frequency-domain ue specific pilots.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..12*N_RB_DL[
  int32_t **rxdataF_uespec_pilots;
847 848 849
  /// \brief Received frequency-domain signal after extraction and channel compensation.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
850
  int32_t **rxdataF_comp0;
851 852 853 854
  /// \brief Received frequency-domain signal after extraction and channel compensation for the second stream. For the SIC receiver we need to store the history of this for each harq process and round
  /// - first index: ? [0..7] (hard coded) accessed via \c harq_pid
  /// - second index: ? [0..7] (hard coded) accessed via \c round
  /// - third index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
855
  /// - fourth index: ? [0..168*N_RB_DL[
856
  int32_t **rxdataF_comp1[8][8];
857 858 859
  /// \brief Downlink channel estimates extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
860
  int32_t **dl_ch_estimates_ext;
861 862 863 864 865 866
  /// \brief Downlink cross-correlation of MIMO channel estimates (unquantized PMI) extracted in PRBS. For the SIC receiver we need to store the history of this for each harq process and round
  /// - first index: ? [0..7] (hard coded) accessed via \c harq_pid
  /// - second index: ? [0..7] (hard coded) accessed via \c round
  /// - third index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - fourth index: ? [0..168*N_RB_DL[
  int32_t **dl_ch_rho_ext[8][8];
867 868 869 870 871 872 873 874
  /// \brief Downlink beamforming channel estimates in frequency domain.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: samples? [0..symbols_per_tti*(ofdm_symbol_size+LTE_CE_FILTER_LENGTH)[
  int32_t **dl_bf_ch_estimates;
  /// \brief Downlink beamforming channel estimates.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
  int32_t **dl_bf_ch_estimates_ext;
875 876 877 878
  /// \brief Downlink cross-correlation of MIMO channel estimates (unquantized PMI) extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
  int32_t **dl_ch_rho2_ext;
879 880
  /// \brief Downlink PMIs extracted in PRBS and grouped in subbands.
  /// - first index: ressource block [0..N_RB_DL[
881
  uint8_t *pmi_ext;
882 883 884
  /// \brief Magnitude of Downlink Channel first layer (16QAM level/First 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
885
  int32_t **dl_ch_mag0;
886 887 888
  /// \brief Magnitude of Downlink Channel second layer (16QAM level/First 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
889
  int32_t **dl_ch_mag1[8][8];
890 891 892
  /// \brief Magnitude of Downlink Channel, first layer (2nd 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
893
  int32_t **dl_ch_magb0;
894 895 896
  /// \brief Magnitude of Downlink Channel second layer (2nd 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
897
  int32_t **dl_ch_magb1[8][8];
898 899 900
  /// \brief Cross-correlation of two eNB signals.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: symbol [0..]
901
  int32_t **rho;
902
  /// never used... always send dl_ch_rho_ext instead...
903
  int32_t **rho_i;
904 905 906
  /// \brief Pointers to llr vectors (2 TBs).
  /// - first index: ? [0..1] (hard coded)
  /// - second index: ? [0..1179743] (hard coded)
907
  int16_t *llr[2];
908
  /// \f$\log_2(\max|H_i|^2)\f$
909
  int16_t log2_maxh;
910 911 912 913
    /// \f$\log_2(\max|H_i|^2)\f$ //this is for TM3-4 layer1 channel compensation
  int16_t log2_maxh0;
    /// \f$\log_2(\max|H_i|^2)\f$ //this is for TM3-4 layer2 channel commpensation
  int16_t log2_maxh1;
914 915
  /// \brief LLR shifts for subband scaling.
  /// - first index: ? [0..168*N_RB_DL[
916
  uint8_t *llr_shifts;
917 918
  /// \brief Pointer to LLR shifts.
  /// - first index: ? [0..168*N_RB_DL[
919
  uint8_t *llr_shifts_p;
920 921 922
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
923
  int16_t **llr128;
924 925 926 927
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
  int16_t **llr128_2ndstream;
928 929
  //uint32_t *rb_alloc;
  //uint8_t Qm[2];
930 931 932 933
  //MIMO_mode_t mimo_mode;
} LTE_UE_PDSCH;

typedef struct {
934 935 936
  /// \brief Received frequency-domain signal after extraction.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
937
  int32_t **rxdataF_ext;
938 939 940
  /// \brief Received frequency-domain signal after extraction and channel compensation.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
941
  double **rxdataF_comp;
942 943 944
  /// \brief Downlink channel estimates extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
945
  int32_t **dl_ch_estimates_ext;
946 947 948
  ///  \brief Downlink cross-correlation of MIMO channel estimates (unquantized PMI) extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
949
  double **dl_ch_rho_ext;