impl_defs_lte.h 48.9 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
#define LTE_SLOTS_PER_SUBFRAME 2

45
46
47
48
#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
49
#define TX_RX_SWITCH_SYMBOL (NUMBER_OF_SYMBOLS_PER_FRAME>>1)
50
51
52
53
54
55
56
57
58
59
60
61
#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
small2    
laurent committed
62
63
64
#ifdef OCP_FRAMEWORK
#include "enums.h"
#else
65
66
67
68
typedef enum {TDD=1,FDD=0} lte_frame_type_t;

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

69
70
typedef enum {LOCALIZED=0,DISTRIBUTED=1} vrb_t;

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

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

93
/// PRACH-ConfigInfo from 36.331 RRC spec
94
typedef struct {
95
  /// Parameter: prach-ConfigurationIndex, see TS 36.211 (5.7.1). \vr{[0..63]}
gauthier's avatar
gauthier committed
96
  uint8_t prach_ConfigIndex;
97
  /// Parameter: High-speed-flag, see TS 36.211 (5.7.2). \vr{[0..1]} 1 corresponds to Restricted set and 0 to Unrestricted set.
gauthier's avatar
gauthier committed
98
  uint8_t highSpeedFlag;
99
  /// 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.
gauthier's avatar
gauthier committed
100
  uint8_t zeroCorrelationZoneConfig;
101
  /// 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.
gauthier's avatar
gauthier committed
102
  uint8_t prach_FreqOffset;
103
104
} PRACH_CONFIG_INFO;

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

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

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

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

/// PUCCH-ConfigCommon from 36.331 RRC spec
typedef struct {
142
  /// 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.
gauthier's avatar
gauthier committed
143
  uint8_t deltaPUCCH_Shift;
144
  /// Parameter: \f$N^{(2)}_\text{RB}\f$, see TS 36.211 (5.4). \vr{[0..98]}
gauthier's avatar
gauthier committed
145
  uint8_t nRB_CQI;
146
  /// Parameter: \f$N^{(1)}_\text{CS}\f$, see TS 36.211 (5.4). \vr{[0..7]}
gauthier's avatar
gauthier committed
147
  uint8_t nCS_AN;
148
  /// Parameter: \f$N^{(1)}_\text{PUCCH}\f$ see TS 36.213 (10.1). \vr{[0..2047]}
gauthier's avatar
gauthier committed
149
  uint16_t n1PUCCH_AN;
fnabet's avatar
fnabet committed
150
151
152
153
154

  /// 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];
155
156
157
158
} PUCCH_CONFIG_COMMON;

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

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

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

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

207
/// lola CBA information
208
typedef struct {
209
  ///
gauthier's avatar
gauthier committed
210
  uint16_t betaOffset_CA_Index;
211
  ///
gauthier's avatar
gauthier committed
212
  uint16_t cShift;
213
214
215
216
} PUSCH_CA_CONFIG_DEDICATED;

/// PDSCH-ConfigCommon from 36.331 RRC spec
typedef struct {
217
  /// 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.
gauthier's avatar
gauthier committed
218
  int8_t referenceSignalPower;
219
  /// Parameter: \f$P_B\f$, see TS 36.213 (Table 5.2-1). \vr{[0..3]}
gauthier's avatar
gauthier committed
220
  uint8_t p_b;
221
222
} PDSCH_CONFIG_COMMON;

223
/// Enumeration for Parameter \f$P_A\f$ \ref PDSCH_CONFIG_DEDICATED::p_a.
224
typedef enum {
225
226
227
228
229
230
231
232
  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
233
234
} PA_t;

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

/// SoundingRS-UL-ConfigCommon Information Element from 36.331 RRC spec
typedef struct {
243
  /// enabled flag=1 means SRS is enabled. \vr{[0..1]}
gauthier's avatar
gauthier committed
244
  uint8_t enabled_flag;
245
  /// 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.
gauthier's avatar
gauthier committed
246
  uint8_t srs_BandwidthConfig;
247
  /// 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.
gauthier's avatar
gauthier committed
248
  uint8_t srs_SubframeConfig;
249
  /// Parameter: Simultaneous-AN-and-SRS, see TS 36.213 (8.2). \vr{[0..1]}
gauthier's avatar
gauthier committed
250
  uint8_t ackNackSRS_SimultaneousTransmission;
251
  /// 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.
gauthier's avatar
gauthier committed
252
  uint8_t srs_MaxUpPts;
253
254
} SOUNDINGRS_UL_CONFIG_COMMON;

255
/// \note UNUSED
256
257
258
259
260
261
262
263
264
265
266
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;

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

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

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

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

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

303
/// DeltaFList-PUCCH from 36.331 RRC spec
304
typedef struct {
305
306
307
308
309
  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;
310
311
312
313
} deltaFList_PUCCH_t;

/// SoundingRS-UL-ConfigDedicated Information Element from 36.331 RRC spec
typedef struct {
314
  /// 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.
gauthier's avatar
gauthier committed
315
  uint8_t srs_Bandwidth;
316
  /// 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.
gauthier's avatar
gauthier committed
317
  uint8_t srs_HoppingBandwidth;
318
  /// Parameter: \f$n_\text{RRC}\f$, see TS 36.211 (5.5.3.2). \vr{[0..23]}
gauthier's avatar
gauthier committed
319
  uint8_t freqDomainPosition;
320
  /// Parameter: Duration, see TS 36.213 (8.2). \vr{[0..1]} 0 corresponds to "single" and 1 to "indefinite".
gauthier's avatar
gauthier committed
321
  uint8_t duration;
322
  /// Parameter: \f$k_\text{TC}\in\{0,1\}\f$, see TS 36.211 (5.5.3.2). \vr{[0..1]}
gauthier's avatar
gauthier committed
323
  uint8_t transmissionComb;
324
  /// Parameter: \f$I_\text{SRS}\f$, see TS 36.213 (table 8.2-1). \vr{[0..1023]}
gauthier's avatar
gauthier committed
325
  uint16_t srs_ConfigIndex;
326
  /// 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.
gauthier's avatar
gauthier committed
327
  uint8_t cyclicShift;
328
  // Parameter: internal implementation: UE SRS configured
fnabet's avatar
fnabet committed
329
  uint8_t srsConfigDedicatedSetup;
Bilel's avatar
Bilel committed
330
331
332
333
  // Parameter: cell srs subframe for internal implementation
  uint8_t srsCellSubframe;
  // Parameter: ue srs subframe for internal implementation
  uint8_t srsUeSubframe;
334
335
} SOUNDINGRS_UL_CONFIG_DEDICATED;

336
/// UplinkPowerControlDedicated Information Element from 36.331 RRC spec
337
typedef struct {
338
  /// 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.
gauthier's avatar
gauthier committed
339
  int8_t p0_UE_PUSCH;
340
  /// 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).
gauthier's avatar
gauthier committed
341
  uint8_t deltaMCS_Enabled;
342
  /// Parameter: Accumulation-enabled, see TS 36.213 (5.1.1.1). \vr{[0..1]} 1 corresponds to "enabled" whereas 0 corresponds to "disabled".
gauthier's avatar
gauthier committed
343
  uint8_t accumulationEnabled;
344
  /// Parameter: \f$P_\text{0\_UE\_PUCCH}(1)\f$, see TS 36.213 (5.1.2.1), unit dB. \vr{[-8..7]}
gauthier's avatar
gauthier committed
345
  int8_t p0_UE_PUCCH;
346
  /// 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.
gauthier's avatar
gauthier committed
347
  int8_t pSRS_Offset;
348
  /// 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.
gauthier's avatar
gauthier committed
349
  uint8_t filterCoefficient;
350
351
} UL_POWER_CONTROL_DEDICATED;

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

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

376
/// UplinkPowerControlCommon Information Element from 36.331 RRC spec \note this structure does not currently make use of \ref deltaFList_PUCCH_t.
377
typedef struct {
378
  /// 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.
gauthier's avatar
gauthier committed
379
  int8_t p0_NominalPUSCH;
380
  /// 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, ...)!
381
  PUSCH_alpha_t alpha;
382
  /// Parameter: \f$P_\text{0\_NOMINAL\_PUCCH}\f$ See TS 36.213 (5.1.2.1), unit dBm. \vr{[-127..-96]}
gauthier's avatar
gauthier committed
383
  int8_t p0_NominalPUCCH;
384
  /// 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].
gauthier's avatar
gauthier committed
385
  int8_t deltaPreambleMsg3;
386
  /// 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.
387
  long deltaF_PUCCH_Format1;
388
  /// 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.
389
  long deltaF_PUCCH_Format1a;
390
  /// 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.
391
  long deltaF_PUCCH_Format1b;
392
  /// 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.
393
  long deltaF_PUCCH_Format2;
394
  /// 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.
395
  long deltaF_PUCCH_Format2a;
396
  /// 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.
397
398
399
  long deltaF_PUCCH_Format2b;
} UL_POWER_CONTROL_CONFIG_COMMON;

400
/// Union for \ref TPC_PDCCH_CONFIG::tpc_Index.
401
typedef union {
402
403
404
405
  /// 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;
406
407
} TPC_INDEX_t;

408
/// TPC-PDCCH-Config Information Element from 36.331 RRC spec
409
typedef struct {
410
  /// RNTI for power control using DCI format 3/3A, see TS 36.212. \vr{[0..65535]}
gauthier's avatar
gauthier committed
411
  uint16_t rnti;
412
  /// 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).
413
414
415
  TPC_INDEX_t tpc_Index;
} TPC_PDCCH_CONFIG;

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

425
/// SchedulingRequestConfig Information Element from 36.331 RRC spec
426
typedef struct {
427
  /// Parameter: \f$n^{(1)}_\text{PUCCH,SRI}\f$, see TS 36.213 (10.1). \vr{[0..2047]}
gauthier's avatar
gauthier committed
428
  uint16_t sr_PUCCH_ResourceIndex;
429
  /// Parameter: \f$I_\text{SR}\f$, see TS 36.213 (10.1). \vr{[0..155]}
gauthier's avatar
gauthier committed
430
  uint8_t sr_ConfigIndex;
431
  /// 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.
432
433
434
  DSR_TRANSMAX_t dsr_TransMax;
} SCHEDULING_REQUEST_CONFIG;

435
/// CQI-ReportPeriodic
436
typedef struct {
knopp's avatar
knopp committed
437
438
  /// Parameter: \f$n^{(2)}_\text{PUCCH}\f$, see TS 36.213 (7.2). \vr{[0..1185]}, -1 indicates inactivity
  int16_t cqi_PUCCH_ResourceIndex;
439
  /// 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
440
  int16_t cqi_PMI_ConfigIndex;
441
  /// Parameter: K, see 36.213 (4.2.2). \vr{[1..4]}
gauthier's avatar
gauthier committed
442
  uint8_t K;
knopp's avatar
knopp committed
443
444
  /// 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;
445
  /// 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.
gauthier's avatar
gauthier committed
446
  uint8_t simultaneousAckNackAndCQI;
knopp's avatar
knopp committed
447
448
449
450
  /// 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;
451
452
} CQI_REPORTPERIODIC;

453
454
455
456
457
458
459
460
461
462
/// 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
463
typedef struct {
464
  /// 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].
465
  CQI_REPORTMODEAPERIODIC cqi_ReportModeAperiodic;
466
  /// Parameter: \f$\Delta_\text{offset}\f$, see TS 36.213 (7.2.3). \vr{[-1..6]}\n Actual value = IE value * 2 [dB].
gauthier's avatar
gauthier committed
467
  int8_t nomPDSCH_RS_EPRE_Offset;
468
469
470
  CQI_REPORTPERIODIC CQI_ReportPeriodic;
} CQI_REPORT_CONFIG;

471
/// MBSFN-SubframeConfig Information Element from 36.331 RRC spec \note deviates from specification.
472
typedef struct {
473
  /// 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}.
474
  int radioframeAllocationPeriod;
475
  /// 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.
476
  int radioframeAllocationOffset;
477
  /// oneFrame or fourFrames. \vr{[0..1]}
478
  int fourFrames_flag;
479
480
481
482
483
  /// 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.
484
485
486
487
488
  int mbsfn_SubframeConfig;
} MBSFN_config_t;

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

  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[MAX_MBSFN_AREA];

} LTE_DL_FRAME_PARMS;

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

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

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

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

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

792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
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;

812
typedef struct {
813
814
815
816
  /// \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[
gauthier's avatar
gauthier committed
817
  int32_t **txdata;
818
819
820
821
  /// \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[
822
  int32_t **txdataF;
823

824
825
826
827
  /// \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[
gauthier's avatar
gauthier committed
828
  int32_t **rxdata;
829

Bilel's avatar
Bilel committed
830
  LTE_UE_COMMON_PER_THREAD common_vars_rx_data_per_thread[RX_NB_TH_MAX];
831

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

typedef struct {
841
842
843
  /// \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[
gauthier's avatar
gauthier committed
844
  int32_t **rxdataF_ext;
845
846
847
848
  /// \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;
849
850
851
  /// \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[
852
  int32_t **rxdataF_comp0;
853
854
855
856
  /// \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
857
  /// - fourth index: ? [0..168*N_RB_DL[
858
  int32_t **rxdataF_comp1[8][8];
859
860
861
  /// \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[
gauthier's avatar
gauthier committed
862
  int32_t **dl_ch_estimates_ext;
863
864
865
866
867
868
  /// \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];
869
870
871
872
873
874
875
876
  /// \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;
877
878
879
880
  /// \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;
881
882
  /// \brief Downlink PMIs extracted in PRBS and grouped in subbands.
  /// - first index: ressource block [0..N_RB_DL[
gauthier's avatar
gauthier committed
883
  uint8_t *pmi_ext;
884
885
886
  /// \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[
887
  int32_t **dl_ch_mag0;
888
889
890
  /// \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[
891
  int32_t **dl_ch_mag1[8][8];
892
893
894
  /// \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[
895
  int32_t **dl_ch_magb0;