impl_defs_lte.h 46.7 KB
Newer Older
1
/*******************************************************************************
2
    OpenAirInterface
ghaddab's avatar
ghaddab committed
3
    Copyright(c) 1999 - 2014 Eurecom
4

ghaddab's avatar
ghaddab committed
5 6 7 8
    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
9 10


ghaddab's avatar
ghaddab committed
11 12 13 14
    OpenAirInterface is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
15

ghaddab's avatar
ghaddab committed
16
    You should have received a copy of the GNU General Public License
17 18
    along with OpenAirInterface.The full GNU General Public License is
   included in this distribution in the file called "COPYING". If not,
ghaddab's avatar
ghaddab committed
19
   see <http://www.gnu.org/licenses/>.
20 21

  Contact Information
ghaddab's avatar
ghaddab committed
22 23
  OpenAirInterface Admin: openair_admin@eurecom.fr
  OpenAirInterface Tech : openair_tech@eurecom.fr
24
  OpenAirInterface Dev  : openair4g-devel@lists.eurecom.fr
25

ghaddab's avatar
ghaddab committed
26
  Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
27

ghaddab's avatar
ghaddab committed
28
 *******************************************************************************/
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

/*! \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"

#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
52
#define TX_RX_SWITCH_SYMBOL (NUMBER_OF_SYMBOLS_PER_FRAME>>1)
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
#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


typedef enum {TDD=1,FDD=0} lte_frame_type_t;

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

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

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

78
/// Enumeration for parameter Ng \ref PHICH_CONFIG_COMMON::phich_resource.
79 80 81 82 83 84 85
typedef enum {
  oneSixth=1,
  half=3,
  one=6,
  two=12
} PHICH_RESOURCE_t;

86
/// PHICH-Config from 36.331 RRC spec
87
typedef struct {
88
  /// Parameter: PHICH-Duration, see TS 36.211 (Table 6.9.3-1).
89
  PHICH_DURATION_t phich_duration;
90
  /// Parameter: Ng, see TS 36.211 (6.9). \details Value oneSixth corresponds to 1/6, half corresponds to 1/2 and so on.
91 92 93
  PHICH_RESOURCE_t phich_resource;
} PHICH_CONFIG_COMMON;

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

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

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

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

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

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

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

171
/// Enumeration for parameter Hopping-mode \ref PUSCH_CONFIG_COMMON::hoppingMode.
172
typedef enum {
173
  interSubFrame=0,
174 175 176
  intraAndInterSubFrame=1
} PUSCH_HOPPING_t;

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

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

201
/// lola CBA information
202
typedef struct {
203
  ///
204
  uint16_t betaOffset_CA_Index;
205
  ///
206
  uint16_t cShift;
207 208 209 210
} PUSCH_CA_CONFIG_DEDICATED;

/// PDSCH-ConfigCommon from 36.331 RRC spec
typedef struct {
211
  /// 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.
212
  int8_t referenceSignalPower;
213
  /// Parameter: \f$P_B\f$, see TS 36.213 (Table 5.2-1). \vr{[0..3]}
214
  uint8_t p_b;
215 216
} PDSCH_CONFIG_COMMON;

217
/// Enumeration for Parameter \f$P_A\f$ \ref PDSCH_CONFIG_DEDICATED::p_a.
218
typedef enum {
219 220 221 222 223 224 225 226
  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
227 228
} PA_t;

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

/// SoundingRS-UL-ConfigCommon Information Element from 36.331 RRC spec
typedef struct {
237
  /// enabled flag=1 means SRS is enabled. \vr{[0..1]}
238
  uint8_t enabled_flag;
239
  /// 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.
240
  uint8_t srs_BandwidthConfig;
241
  /// 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.
242
  uint8_t srs_SubframeConfig;
243
  /// Parameter: Simultaneous-AN-and-SRS, see TS 36.213 (8.2). \vr{[0..1]}
244
  uint8_t ackNackSRS_SimultaneousTransmission;
245
  /// 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.
246
  uint8_t srs_MaxUpPts;
247 248
} SOUNDINGRS_UL_CONFIG_COMMON;

249
/// \note UNUSED
250 251 252 253 254 255 256 257 258 259 260
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;

261
/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format1.
262
typedef enum {
263 264 265
  deltaF_PUCCH_Format1_deltaF_2  = 0,
  deltaF_PUCCH_Format1_deltaF0   = 1,
  deltaF_PUCCH_Format1_deltaF2   = 2
266
} deltaF_PUCCH_Format1_t;
267 268

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format1b.
269
typedef enum {
270 271 272
  deltaF_PUCCH_Format1b_deltaF1  = 0,
  deltaF_PUCCH_Format1b_deltaF3  = 1,
  deltaF_PUCCH_Format1b_deltaF5  = 2
273
} deltaF_PUCCH_Format1b_t;
274 275

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2.
276
typedef enum {
277 278 279 280
  deltaF_PUCCH_Format2_deltaF_2  = 0,
  deltaF_PUCCH_Format2_deltaF0   = 1,
  deltaF_PUCCH_Format2_deltaF1   = 2,
  deltaF_PUCCH_Format2_deltaF2   = 3
281
} deltaF_PUCCH_Format2_t;
282 283

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2a.
284
typedef enum {
285 286 287
  deltaF_PUCCH_Format2a_deltaF_2 = 0,
  deltaF_PUCCH_Format2a_deltaF0  = 1,
  deltaF_PUCCH_Format2a_deltaF2  = 2
288
} deltaF_PUCCH_Format2a_t;
289 290

/// Enumeration for \ref deltaFList_PUCCH_t::deltaF_PUCCH_Format2b.
291
typedef enum {
292 293 294
  deltaF_PUCCH_Format2b_deltaF_2 = 0,
  deltaF_PUCCH_Format2b_deltaF0  = 1,
  deltaF_PUCCH_Format2b_deltaF2  = 2
295 296
} deltaF_PUCCH_Format2b_t;

297
/// DeltaFList-PUCCH from 36.331 RRC spec
298
typedef struct {
299 300 301 302 303
  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;
304 305 306 307
} deltaFList_PUCCH_t;

/// SoundingRS-UL-ConfigDedicated Information Element from 36.331 RRC spec
typedef struct {
308
  /// 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.
309
  uint8_t srs_Bandwidth;
310
  /// 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.
311
  uint8_t srs_HoppingBandwidth;
312
  /// Parameter: \f$n_\text{RRC}\f$, see TS 36.211 (5.5.3.2). \vr{[0..23]}
313
  uint8_t freqDomainPosition;
314
  /// Parameter: Duration, see TS 36.213 (8.2). \vr{[0..1]} 0 corresponds to "single" and 1 to "indefinite".
315
  uint8_t duration;
316
  /// Parameter: \f$k_\text{TC}\in\{0,1\}\f$, see TS 36.211 (5.5.3.2). \vr{[0..1]}
317
  uint8_t transmissionComb;
318
  /// Parameter: \f$I_\text{SRS}\f$, see TS 36.213 (table 8.2-1). \vr{[0..1023]}
319
  uint16_t srs_ConfigIndex;
320
  /// 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.
321
  uint8_t cyclicShift;
322 323
} SOUNDINGRS_UL_CONFIG_DEDICATED;

324
/// UplinkPowerControlDedicated Information Element from 36.331 RRC spec
325
typedef struct {
326
  /// 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.
327
  int8_t p0_UE_PUSCH;
328
  /// 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).
329
  uint8_t deltaMCS_Enabled;
330
  /// Parameter: Accumulation-enabled, see TS 36.213 (5.1.1.1). \vr{[0..1]} 1 corresponds to "enabled" whereas 0 corresponds to "disabled".
331
  uint8_t accumulationEnabled;
332
  /// Parameter: \f$P_\text{0\_UE\_PUCCH}(1)\f$, see TS 36.213 (5.1.2.1), unit dB. \vr{[-8..7]}
333
  int8_t p0_UE_PUCCH;
334
  /// 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.
335
  int8_t pSRS_Offset;
336
  /// 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.
337
  uint8_t filterCoefficient;
338 339
} UL_POWER_CONTROL_DEDICATED;

340
/// Enumeration for parameter \f$\alpha\f$ \ref UL_POWER_CONTROL_CONFIG_COMMON::alpha.
341 342 343 344 345 346 347 348 349 350 351
typedef enum {
  al0=0,
  al04=1,
  al05=2,
  al06=3,
  al07=4,
  al08=5,
  al09=6,
  al1=7
} PUSCH_alpha_t;

352
/// \note UNUSED
353 354 355 356 357 358
typedef enum {
  deltaFm2=0,
  deltaF0,
  deltaF1,
  deltaF2,
  deltaF3,
359
  deltaF5
360 361
} deltaF_PUCCH_t;

362
/// UplinkPowerControlCommon Information Element from 36.331 RRC spec \note this structure does not currently make use of \ref deltaFList_PUCCH_t.
363
typedef struct {
364
  /// 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.
365
  int8_t p0_NominalPUSCH;
366
  /// 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, ...)!
367
  PUSCH_alpha_t alpha;
368
  /// Parameter: \f$P_\text{0\_NOMINAL\_PUCCH}\f$ See TS 36.213 (5.1.2.1), unit dBm. \vr{[-127..-96]}
369
  int8_t p0_NominalPUCCH;
370
  /// 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].
371
  int8_t deltaPreambleMsg3;
372
  /// 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.
373
  long deltaF_PUCCH_Format1;
374
  /// 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.
375
  long deltaF_PUCCH_Format1a;
376
  /// 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.
377
  long deltaF_PUCCH_Format1b;
378
  /// 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.
379
  long deltaF_PUCCH_Format2;
380
  /// 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.
381
  long deltaF_PUCCH_Format2a;
382
  /// 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.
383 384 385
  long deltaF_PUCCH_Format2b;
} UL_POWER_CONTROL_CONFIG_COMMON;

386
/// Union for \ref TPC_PDCCH_CONFIG::tpc_Index.
387
typedef union {
388 389 390 391
  /// 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;
392 393
} TPC_INDEX_t;

394
/// TPC-PDCCH-Config Information Element from 36.331 RRC spec
395
typedef struct {
396
  /// RNTI for power control using DCI format 3/3A, see TS 36.212. \vr{[0..65535]}
397
  uint16_t rnti;
398
  /// 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).
399 400 401
  TPC_INDEX_t tpc_Index;
} TPC_PDCCH_CONFIG;

402
/// Enumeration for parameter SR transmission \ref SCHEDULING_REQUEST_CONFIG::dsr_TransMax.
403 404 405 406 407 408 409 410
typedef enum {
  sr_n4=0,
  sr_n8=1,
  sr_n16=2,
  sr_n32=3,
  sr_n64=4
} DSR_TRANSMAX_t;

411
/// SchedulingRequestConfig Information Element from 36.331 RRC spec
412
typedef struct {
413
  /// Parameter: \f$n^{(1)}_\text{PUCCH,SRI}\f$, see TS 36.213 (10.1). \vr{[0..2047]}
414
  uint16_t sr_PUCCH_ResourceIndex;
415
  /// Parameter: \f$I_\text{SR}\f$, see TS 36.213 (10.1). \vr{[0..155]}
416
  uint8_t sr_ConfigIndex;
417
  /// 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.
418 419 420
  DSR_TRANSMAX_t dsr_TransMax;
} SCHEDULING_REQUEST_CONFIG;

421
/// CQI-ReportPeriodic
422
typedef struct {
423
  /// Parameter: \f$n^{(2)}_\text{PUCCH}\f$, see TS 36.213 (7.2). \vr{[0..1185]}
424
  uint16_t cqi_PUCCH_ResourceIndex;
425
  /// 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]}
426
  uint16_t cqi_PMI_ConfigIndex;
427
  /// Parameter: K, see 36.213 (4.2.2). \vr{[1..4]}
428
  uint8_t K;
429
  /// Parameter: RI Config Index \f$I_\text{RI}\f$, see TS 36.213 (7.2.2-1B). \vr{[0..1023]}
430
  uint16_t ri_ConfigIndex;
431
  /// 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.
432
  uint8_t simultaneousAckNackAndCQI;
433 434
} CQI_REPORTPERIODIC;

435 436 437 438 439 440 441 442 443 444
/// 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
445
typedef struct {
446
  /// 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].
447
  CQI_REPORTMODEAPERIODIC cqi_ReportModeAperiodic;
448
  /// Parameter: \f$\Delta_\text{offset}\f$, see TS 36.213 (7.2.3). \vr{[-1..6]}\n Actual value = IE value * 2 [dB].
449
  int8_t nomPDSCH_RS_EPRE_Offset;
450 451 452
  CQI_REPORTPERIODIC CQI_ReportPeriodic;
} CQI_REPORT_CONFIG;

453
/// MBSFN-SubframeConfig Information Element from 36.331 RRC spec \note deviates from specification.
454
typedef struct {
455
  /// 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}.
456
  int radioframeAllocationPeriod;
457
  /// 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.
458
  int radioframeAllocationOffset;
459
  /// oneFrame or fourFrames. \vr{[0..1]}
460
  int fourFrames_flag;
461 462 463 464 465
  /// 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.
466 467 468 469 470
  int mbsfn_SubframeConfig;
} MBSFN_config_t;

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

  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[MAX_MBSFN_AREA];

} LTE_DL_FRAME_PARMS;

typedef enum {
574
  /// TM1
575
  SISO=0,
576
  /// TM2
577
  ALAMOUTI=1,
578
  /// TM3
579
  LARGE_CDD=2,
580
  /// the next 6 entries are for TM5
581 582 583 584 585 586
  UNIFORM_PRECODING11=3,
  UNIFORM_PRECODING1m1=4,
  UNIFORM_PRECODING1j=5,
  UNIFORM_PRECODING1mj=6,
  PUSCH_PRECODING0=7,
  PUSCH_PRECODING1=8,
587
  /// the next 3 entries are for TM4
588 589
  DUALSTREAM_UNIFORM_PRECODING1=9,
  DUALSTREAM_UNIFORM_PRECODINGj=10,
Raymond Knopp's avatar
 
Raymond Knopp committed
590
  DUALSTREAM_PUSCH_PRECODING=11,
591 592 593
  TM7=12,
  TM8=13,
  TM9_10=14
594 595
} MIMO_mode_t;

596 597 598 599 600 601 602 603 604
typedef enum {
  /// MRT
  MRT=0,
  /// ZF
  ZF=1,
  /// MMSE
  MMSE=2
} PRECODE_TYPE_t;

605
typedef struct {
606 607 608 609 610
  /// \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:
611
  int32_t **txdata[3];
612
  /// \brief holds the transmit data in the frequency domain.
Xiwen JIANG's avatar
Xiwen JIANG committed
613
  /// For IFFT_FPGA this points to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER. //?
614
  /// - first index: eNB id [0..2] (hard coded)
Xiwen JIANG's avatar
Xiwen JIANG committed
615
  /// - second index: tx antenna [0..14[ where 14 is the total supported antenna ports.
616
  /// - third index: sample [0..]
617
  int32_t **txdataF[3];
Xiwen JIANG's avatar
Xiwen JIANG committed
618 619 620 621 622
  /// \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..]
623
  int32_t **txdataF_BF[3];
624 625 626 627 628
  /// \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: eNB id [0..2] (hard coded)
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..]
629
  int32_t **rxdata[3];
630 631 632 633
  /// \brief Holds the last subframe of received data in time domain after removal of 7.5kHz frequency offset.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..samples_per_tti[
634
  int32_t **rxdata_7_5kHz[3];
635 636 637 638
  /// \brief Holds the received data in the frequency domain.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size*frame_parms->symbols_per_tti[
639
  int32_t **rxdataF[3];
640 641 642
  /// \brief Holds output of the sync correlator.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: sample [0..samples_per_tti*10[
643
  uint32_t *sync_corr[3];
Xiwen JIANG's avatar
Xiwen JIANG committed
644
  /// \brief Holds the beamforming weights
645
  /// - first index: eNB id [0..2] (hard coded)
646
  /// - second index: eNB antenna port index (hard coded)
647 648 649
  /// - third index: tx antenna [0..nb_antennas_tx[
  /// - fourth index: sample [0..]
  int32_t **beam_weights[3][15];
650 651
  /// \brief Holds the tdd reciprocity calibration coefficients 
  /// - first index: eNB id [0..2] (hard coded) 
652 653
  /// - second index: tx antenna [0..nb_antennas_tx[
  /// - third index: frequency [0..]
654
  int32_t **tdd_calib_coeffs[3];
655 656
} LTE_eNB_COMMON;

657
typedef struct {
658 659 660 661
  /// \brief Hold the channel estimates in frequency domain based on SRS.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..ofdm_symbol_size[
662
  int32_t **srs_ch_estimates[3];
663 664 665 666
  /// \brief Hold the channel estimates in time domain based on SRS.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size[
667
  int32_t **srs_ch_estimates_time[3];
668 669
  /// \brief Holds the SRS for channel estimation at the RX.
  /// - first index: ? [0..ofdm_symbol_size[
670
  int32_t *srs;
671 672
} LTE_eNB_SRS;

673
typedef struct {
674 675 676 677 678 679
  /// \brief Holds the received data in the frequency domain for the allocated RBs in repeated format.
  /// - first index: eNB id [0..2] (hard coded)
  /// - 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
680
  int32_t **rxdataF_ext[3];
681 682 683 684
  /// \brief Holds the received data in the frequency domain for the allocated RBs in normal format.
  /// - first index: eNB id [0..2] (hard coded)
  /// - 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[
685
  int32_t **rxdataF_ext2[3];
686 687 688 689
  /// \brief Hold the channel estimates in time domain based on DRS.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..4*ofdm_symbol_size[
690
  int32_t **drs_ch_estimates_time[3];
691 692 693 694
  /// \brief Hold the channel estimates in frequency domain based on DRS.
  /// - 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[
695
  int32_t **drs_ch_estimates[3];
696 697 698 699
  /// \brief Hold the channel estimates 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[
700
  int32_t **drs_ch_estimates_0[3];
701 702 703 704
  /// \brief Hold the channel estimates for UE1 in case of Distributed Almouti 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[
705
  int32_t **drs_ch_estimates_1[3];
706 707 708 709
  /// \brief Holds the compensated signal.
  /// - 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[
710
  int32_t **rxdataF_comp[3];
711 712 713 714
  /// \brief Hold the compensated data (y)*(h0*) 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[
715
  int32_t **rxdataF_comp_0[3];
716 717 718 719
  /// \brief Hold the compensated data (y*)*(h1) 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[
720
  int32_t **rxdataF_comp_1[3];
721 722 723 724
  /// \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[
725
  int32_t **ul_ch_mag[3];
726 727 728 729
  /// \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[
730
  int32_t **ul_ch_magb[3];
731 732 733 734
  /// \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[
735
  int32_t **ul_ch_mag_0[3];
736 737 738 739
  /// \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[
740
  int32_t **ul_ch_magb_0[3];
741 742 743 744
  /// \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[
745
  int32_t **ul_ch_mag_1[3];
746 747 748 749
  /// \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[
750
  int32_t **ul_ch_magb_1[3];
751 752 753 754 755 756
  /// 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];
757 758
  /// \brief llr values.
  /// - first index: ? [0..1179743] (hard coded)
759
  int16_t *llr;
760 761 762 763 764 765
#ifdef LOCALIZATION
  /// number of active subcarrier for a specific UE
  int32_t active_subcarrier;
  /// subcarrier power in dBm
  int32_t *subcarrier_power;
#endif
766 767 768
} LTE_eNB_PUSCH;

typedef struct {
769 770 771 772
  /// \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[
773
  int32_t **txdata;
774 775 776 777
  /// \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[
778
  int32_t **txdataF;
779 780 781 782
  /// \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[
783
  int32_t **rxdata;
784 785 786
  /// \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[
787
  int32_t **rxdataF;
788 789 790
  /// \brief ?.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..20*ofdm_symbol_size*symbols_per_tti[
791
  int32_t **rxdataF2;
792 793 794 795
  /// \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)[
796
  int32_t **dl_ch_estimates[7];
797 798 799 800
  /// \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[
801
  int32_t **dl_ch_estimates_time[7];
802
  /// holds output of the sync correlator
803
  int32_t *sync_corr;
804
  /// estimated frequency offset (in radians) for all subcarriers
805
  int32_t freq_offset;
806
  /// eNb_id user is synched to
807
  int32_t eNb_id;
808 809 810
} LTE_UE_COMMON;

typedef struct {
811 812 813
  /// \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[
814
  int32_t **rxdataF_ext;
815 816 817 818
  /// \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;
819 820 821
  /// \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[
822
  int32_t **rxdataF_comp0;
823
  /// \brief Received frequency-domain signal after extraction and channel compensation.
824 825
  /// - first index: ? [0..7] (hard coded) accessed via \c round
  /// - second index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
826
  /// - third index: ? [0..168*N_RB_DL[
Raymond Knopp's avatar
Raymond Knopp committed
827
  int32_t **rxdataF_comp1[8];
828 829 830
  /// \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[
831
  int32_t **dl_ch_estimates_ext;
832 833 834 835 836 837 838 839
  /// \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;
840 841 842
  /// \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[
843
  int32_t **dl_ch_rho_ext;
844 845 846 847
  /// \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;
848 849
  /// \brief Downlink PMIs extracted in PRBS and grouped in subbands.
  /// - first index: ressource block [0..N_RB_DL[
850
  uint8_t *pmi_ext;
851 852 853
  /// \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[
854
  int32_t **dl_ch_mag0;
855 856 857
  /// \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[
858
  int32_t **dl_ch_mag1;
859 860 861
  /// \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[
862
  int32_t **dl_ch_magb0;
863 864 865
  /// \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[
866
  int32_t **dl_ch_magb1;
867 868 869
  /// \brief Cross-correlation of two eNB signals.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: symbol [0..]
870
  int32_t **rho;
871
  /// never used... always send dl_ch_rho_ext instead...
872
  int32_t **rho_i;
873 874 875
  /// \brief Pointers to llr vectors (2 TBs).
  /// - first index: ? [0..1] (hard coded)
  /// - second index: ? [0..1179743] (hard coded)
876
  int16_t *llr[2];
877
  /// \f$\log_2(\max|H_i|^2)\f$
878
  int16_t log2_maxh;
879 880
  /// \brief LLR shifts for subband scaling.
  /// - first index: ? [0..168*N_RB_DL[
881
  uint8_t *llr_shifts;
882 883
  /// \brief Pointer to LLR shifts.
  /// - first index: ? [0..168*N_RB_DL[
884
  uint8_t *llr_shifts_p;
885 886 887
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
888
  int16_t **llr128;
889 890 891 892
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
  int16_t **llr128_2ndstream;
893 894
  //uint32_t *rb_alloc;
  //uint8_t Qm[2];
895 896 897 898
  //MIMO_mode_t mimo_mode;
} LTE_UE_PDSCH;

typedef struct {
899 900 901
  /// \brief Received frequency-domain signal after extraction.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
902
  int32_t **rxdataF_ext;
903 904 905
  /// \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..]
906
  double **rxdataF_comp;
907 908 909
  /// \brief Downlink channel estimates extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
910
  int32_t **dl_ch_estimates_ext;
911 912 913
  ///  \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..]
914
  double **dl_ch_rho_ext;
915 916
  /// \brief Downlink PMIs extracted in PRBS and grouped in subbands.
  /// - first index: ressource block [0..N_RB_DL[
917
  uint8_t *pmi_ext;
918 919 920
  /// \brief Magnitude of Downlink Channel (16QAM level/First 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
921
  double **dl_ch_mag;
922 923 924
  /// \brief Magnitude of Downlink Channel (2nd 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
925
  double **dl_ch_magb;
926 927 928
  /// \brief Cross-correlation of two eNB signals.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..]
929 930
  double **rho;
  /// never used... always send dl_ch_rho_ext instead...
931
  double **rho_i;
932 933 934
  /// \brief Pointers to llr vectors (2 TBs).
  /// - first index: ? [0..1] (hard coded)
  /// - second index: ? [0..1179743] (hard coded)
935
  int16_t *llr[2];
936
  /// \f$\log_2(\max|H_i|^2)\f$
937
  uint8_t log2_maxh;
938 939 940
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
941 942 943
  int16_t **llr128;
  //uint32_t *rb_alloc;
  //uint8_t Qm[2];
944 945 946 947
  //MIMO_mode_t mimo_mode;
} LTE_UE_PDSCH_FLP;

typedef struct {
948
  /// \brief Pointers to extracted PDCCH symbols in frequency-domain.
949 950
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
951
  int32_t **rxdataF_ext;
952 953 954
  /// \brief Pointers to extracted and compensated PDCCH symbols in frequency-domain.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
955
  int32_t **rxdataF_comp;
956 957 958
  /// \brief Pointers to extracted channel estimates of PDCCH symbols.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
959
  int32_t **dl_ch_estimates_ext;
960 961 962
  /// \brief Pointers to channel cross-correlation vectors for multi-eNB detection.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
963
  int32_t **dl_ch_rho_ext;
964 965 966
  /// \brief Pointers to channel cross-correlation vectors for multi-eNB detection.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..]
967
  int32_t **rho;
968 969
  /// \brief Pointer to llrs, 4-bit resolution.
  /// - first index: ? [0..48*N_RB_DL[
970
  uint16_t *llr;
971 972
  /// \brief Pointer to llrs, 16-bit resolution.
  /// - first index: ? [0..96*N_RB_DL[
973
  uint16_t *llr16;
974 975
  /// \brief \f$\overline{w}\f$ from 36-211.
  /// - first index: ? [0..48*N_RB_DL[
976
  uint16_t *wbar;
977 978
  /// \brief PDCCH/DCI e-sequence (input to rate matching).
  /// - first index: ? [0..96*N_RB_DL[
979
  int8_t *e_rx;
980
  /// number of PDCCH symbols in current subframe
981
  uint8_t num_pdcch_symbols;
982
  /// Allocated CRNTI for UE
983
  uint16_t crnti;
984
  /// Total number of PDU errors (diagnostic mode)
985
  uint32_t dci_errors;
986
  /// Total number of PDU received
987
  uint32_t dci_received;
988
  /// Total number of DCI False detection (diagnostic mode)
989
  uint32_t dci_false;
990
  /// Total number of DCI missed (diagnostic mode)
991
  uint32_t dci_missed;
992
  /// nCCE for PUCCH per subframe
993
  uint8_t nCCE[10];
994 995 996 997
} LTE_UE_PDCCH;

#define PBCH_A 24
typedef struct {
998 999 1000
  uint8_t pbch_d[96+(3*(16+PBCH_A))];
  uint8_t pbch_w[3*3*(16+PBCH_A)];
  uint8_t pbch_e[1920];
1001 1002 1003
} LTE_eNB_PBCH;

typedef struct {
1004 1005 1006
  /// \brief Pointers to extracted PBCH symbols in frequency-domain.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..287] (hard coded)
1007
  int32_t **rxdataF_ext;
1008 1009 1010
  /// \brief Pointers to extracted and compensated PBCH symbols in frequency-domain.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..287] (hard coded)
1011
  int32_t **rxdataF_comp;
1012 1013 1014
  /// \brief Pointers to downlink channel estimates in frequency-domain extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..287] (hard coded)
1015
  int32_t **dl_ch_estimates_ext;
1016 1017
  /// \brief Pointer to PBCH llrs.
  /// - first index: ? [0..1919] (hard coded)
1018
  int8_t *llr;
1019 1020
  /// \brief Pointer to PBCH decoded output.
  /// - first index: ? [0..63] (hard coded)
1021
  uint8_t *decoded_output;
1022
  /// \brief Total number of PDU errors.
1023
  uint32_t pdu_errors;
1024
  /// \brief Total number of PDU errors 128 frames ago.
1025
  uint32_t pdu_errors_last;
1026
  /// \brief Total number of consecutive PDU errors.
1027
  uint32_t pdu_errors_conseq;
1028
  /// \brief FER (in percent) .
1029
  uint32_t pdu_fer;
1030 1031 1032
} LTE_UE_PBCH;

typedef struct {
1033 1034 1035
  int16_t amp;
  int16_t *prachF;
  int16_t *prach;
1036 1037 1038
} LTE_UE_PRACH;

typedef struct {
1039 1040
  /// \brief ?.
  /// first index: ? [0..1023] (hard coded)
1041
  int16_t *prachF;
1042 1043 1044
  /// \brief ?.
  /// first index: rx antenna [0..3] (hard coded) \note Hard coded array size indexed by \c nb_antennas_rx.
  /// second index: ? [0..ofdm_symbol_size*12[
1045
  int16_t *rxsigF[4];
1046 1047 1048 1049
  /// \brief local buffer to compute prach_ifft (necessary in case of multiple CCs)
  /// first index: rx antenna [0..3] (hard coded) \note Hard coded array size indexed by \c nb_antennas_rx.
  /// second index: ? [0..2047] (hard coded)
  int16_t *prach_ifft[4];
1050 1051 1052 1053
} LTE_eNB_PRACH;

typedef struct {
  /// Preamble index for PRACH (0-63)
1054
  uint8_t ra_PreambleIndex;
1055
  /// RACH MaskIndex
1056
  uint8_t ra_RACH_MaskIndex;
1057
  /// Target received power at eNB (-120 ... -82 dBm)
1058
  int8_t ra_PREAMBLE_RECEIVED_TARGET_POWER;
1059
  /// PRACH index for TDD (0 ... 6) depending on TDD configuration and prachConfigIndex
1060
  uint8_t ra_TDD_map_index;
1061
  /// Corresponding RA-RNTI for UL-grant
1062
  uint16_t ra_RNTI;
1063
  /// Pointer to Msg3 payload for UL-grant
1064
  uint8_t *Msg3;
1065 1066 1067 1068
} PRACH_RESOURCES_t;

typedef struct {
  /// Downlink Power offset field
1069
  uint8_t dl_pow_off;
1070
  ///Subband resource allocation field
1071
  uint8_t rballoc_sub[50];
1072
  ///Total number of PRBs indicator
1073
  uint8_t pre_nb_available_rbs;
1074
} MU_MIMO_mode;
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

typedef enum {
  NOT_SYNCHED=0,
  PRACH=1,
  RA_RESPONSE=2,
  PUSCH=3,
  RESYNCH=4
} UE_MODE_t;



typedef enum {SF_DL, SF_UL, SF_S} lte_subframe_t;

#endif