impl_defs_lte.h 45.6 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;
fnabet's avatar
fnabet committed
151 152 153 154 155

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

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

176
/// Enumeration for parameter Hopping-mode \ref PUSCH_CONFIG_COMMON::hoppingMode.
177
typedef enum {
178
  interSubFrame=0,
179 180 181
  intraAndInterSubFrame=1
} PUSCH_HOPPING_t;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

432
/// CQI-ReportPeriodic
433
typedef struct {
434
  /// Parameter: \f$n^{(2)}_\text{PUCCH}\f$, see TS 36.213 (7.2). \vr{[0..1185]}
435
  uint16_t cqi_PUCCH_ResourceIndex;
436
  /// 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]}
437
  uint16_t cqi_PMI_ConfigIndex;
438
  /// Parameter: K, see 36.213 (4.2.2). \vr{[1..4]}
439
  uint8_t K;
440
  /// Parameter: RI Config Index \f$I_\text{RI}\f$, see TS 36.213 (7.2.2-1B). \vr{[0..1023]}
441
  uint16_t ri_ConfigIndex;
442
  /// 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.
443
  uint8_t simultaneousAckNackAndCQI;
444 445
} CQI_REPORTPERIODIC;

446 447 448 449 450 451 452 453 454 455
/// 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
456
typedef struct {
457
  /// 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].
458
  CQI_REPORTMODEAPERIODIC cqi_ReportModeAperiodic;
459
  /// Parameter: \f$\Delta_\text{offset}\f$, see TS 36.213 (7.2.3). \vr{[-1..6]}\n Actual value = IE value * 2 [dB].
460
  int8_t nomPDSCH_RS_EPRE_Offset;
461 462 463
  CQI_REPORTPERIODIC CQI_ReportPeriodic;
} CQI_REPORT_CONFIG;

464
/// MBSFN-SubframeConfig Information Element from 36.331 RRC spec \note deviates from specification.
465
typedef struct {
466
  /// 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}.
467
  int radioframeAllocationPeriod;
468
  /// 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.
469
  int radioframeAllocationOffset;
470
  /// oneFrame or fourFrames. \vr{[0..1]}
471
  int fourFrames_flag;
472 473 474 475 476
  /// 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.
477 478 479 480 481
  int mbsfn_SubframeConfig;
} MBSFN_config_t;

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

  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[MAX_MBSFN_AREA];

} LTE_DL_FRAME_PARMS;

typedef enum {
585
  /// TM1
586
  SISO=0,
587
  /// TM2
588
  ALAMOUTI=1,
589
  /// TM3
590
  LARGE_CDD=2,
591
  /// the next 6 entries are for TM5
592 593 594 595 596 597
  UNIFORM_PRECODING11=3,
  UNIFORM_PRECODING1m1=4,
  UNIFORM_PRECODING1j=5,
  UNIFORM_PRECODING1mj=6,
  PUSCH_PRECODING0=7,
  PUSCH_PRECODING1=8,
598
  /// the next 3 entries are for TM4
599 600
  DUALSTREAM_UNIFORM_PRECODING1=9,
  DUALSTREAM_UNIFORM_PRECODINGj=10,
Raymond Knopp's avatar
 
Raymond Knopp committed
601 602 603
  DUALSTREAM_PUSCH_PRECODING=11,
  TM8=12,
  TM9_10=13
604 605
} MIMO_mode_t;

606
typedef struct {
607 608 609 610 611
  /// \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:
612
  int32_t **txdata[3];
613 614 615 616 617
  /// \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: eNB id [0..2] (hard coded)
  /// - second index: tx antenna [0..nb_antennas_tx[
  /// - third index: sample [0..]
618
  int32_t **txdataF[3];
619 620
  /// \brief Holds the received data in time domain.
  /// Should point to the same memory as PHY_vars->rx_vars[a].RX_DMA_BUFFER.
621
  /// - first index: sector id [0..2] (hard coded)
622 623
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..]
624
  int32_t **rxdata[3];
625
  /// \brief Holds the last subframe of received data in time domain after removal of 7.5kHz frequency offset.
626
  /// - first index: secotr id [0..2] (hard coded)
627 628
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: sample [0..samples_per_tti[
629
  int32_t **rxdata_7_5kHz[3];
630
  /// \brief Holds the received data in the frequency domain.
631
  /// - first index: sector id [0..2] (hard coded)
632 633
  /// - second index: rx antenna [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size*frame_parms->symbols_per_tti[
634
  int32_t **rxdataF[3];
635
  /// \brief Holds output of the sync correlator.
636
  /// - first index: sector id [0..2] (hard coded)
637
  /// - second index: sample [0..samples_per_tti*10[
638
  uint32_t *sync_corr[3];
639 640
} LTE_eNB_COMMON;

641
typedef struct {
642
  /// \brief Hold the channel estimates in frequency domain based on SRS.
643
  /// - first index: sector id [0..2] (hard coded)
644 645
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..ofdm_symbol_size[
646
  int32_t **srs_ch_estimates[3];
647
  /// \brief Hold the channel estimates in time domain based on SRS.
648
  /// - first index: sector id [0..2] (hard coded)
649 650
  /// - second index: rx antenna id [0..nb_antennas_rx[
  /// - third index: ? [0..2*ofdm_symbol_size[
651
  int32_t **srs_ch_estimates_time[3];
652 653
  /// \brief Holds the SRS for channel estimation at the RX.
  /// - first index: ? [0..ofdm_symbol_size[
654
  int32_t *srs;
655 656
} LTE_eNB_SRS;

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

typedef struct {
753 754 755 756
  /// \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[
757
  int32_t **txdata;
758 759 760 761
  /// \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[
762
  int32_t **txdataF;
763 764 765 766
  /// \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[
767
  int32_t **rxdata;
768 769 770
  /// \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[
771
  int32_t **rxdataF;
772 773 774
  /// \brief ?.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..20*ofdm_symbol_size*symbols_per_tti[
775
  int32_t **rxdataF2;
776 777 778 779
  /// \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)[
780
  int32_t **dl_ch_estimates[7];
781 782 783 784
  /// \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[
785
  int32_t **dl_ch_estimates_time[7];
786
  /// holds output of the sync correlator
787
  int32_t *sync_corr;
788
  /// estimated frequency offset (in radians) for all subcarriers
789
  int32_t freq_offset;
790
  /// eNb_id user is synched to
791
  int32_t eNb_id;
792 793 794
} LTE_UE_COMMON;

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

typedef struct {
871 872 873
  /// \brief Received frequency-domain signal after extraction.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
874
  int32_t **rxdataF_ext;
875 876 877
  /// \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..]
878
  double **rxdataF_comp;
879 880 881
  /// \brief Downlink channel estimates extracted in PRBS.
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
882
  int32_t **dl_ch_estimates_ext;
883 884 885
  ///  \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..]
886
  double **dl_ch_rho_ext;
887 888
  /// \brief Downlink PMIs extracted in PRBS and grouped in subbands.
  /// - first index: ressource block [0..N_RB_DL[
889
  uint8_t *pmi_ext;
890 891 892
  /// \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..]
893
  double **dl_ch_mag;
894 895 896
  /// \brief Magnitude of Downlink Channel (2nd 64QAM level).
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..]
897
  double **dl_ch_magb;
898 899 900
  /// \brief Cross-correlation of two eNB signals.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..]
901 902
  double **rho;
  /// never used... always send dl_ch_rho_ext instead...
903
  double **rho_i;
904 905 906
  /// \brief Pointers to llr vectors (2 TBs).
  /// - first index: ? [0..1] (hard coded)
  /// - second index: ? [0..1179743] (hard coded)
907
  int16_t *llr[2];
908
  /// \f$\log_2(\max|H_i|^2)\f$
909
  uint8_t log2_maxh;
910 911 912
  /// \brief Pointers to llr vectors (128-bit alignment).
  /// - first index: ? [0..0] (hard coded)
  /// - second index: ? [0..]
913 914 915
  int16_t **llr128;
  //uint32_t *rb_alloc;
  //uint8_t Qm[2];
916 917 918 919
  //MIMO_mode_t mimo_mode;
} LTE_UE_PDSCH_FLP;

typedef struct {
920
  /// \brief Pointers to extracted PDCCH symbols in frequency-domain.
921 922
  /// - first index: ? [0..7] (hard coded) FIXME! accessed via \c nb_antennas_rx
  /// - second index: ? [0..168*N_RB_DL[
923
  int32_t **rxdataF_ext;
924 925 926
  /// \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[
927
  int32_t **rxdataF_comp;
928 929 930
  /// \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[
931
  int32_t **dl_ch_estimates_ext;
932 933 934
  /// \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[
935
  int32_t **dl_ch_rho_ext;
936 937 938
  /// \brief Pointers to channel cross-correlation vectors for multi-eNB detection.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..]
939
  int32_t **rho;
940 941
  /// \brief Pointer to llrs, 4-bit resolution.
  /// - first index: ? [0..48*N_RB_DL[
942
  uint16_t *llr;
943 944
  /// \brief Pointer to llrs, 16-bit resolution.
  /// - first index: ? [0..96*N_RB_DL[
945
  uint16_t *llr16;
946 947
  /// \brief \f$\overline{w}\f$ from 36-211.
  /// - first index: ? [0..48*N_RB_DL[
948
  uint16_t *wbar;
949 950
  /// \brief PDCCH/DCI e-sequence (input to rate matching).
  /// - first index: ? [0..96*N_RB_DL[
951
  int8_t *e_rx;
952
  /// number of PDCCH symbols in current subframe
953
  uint8_t num_pdcch_symbols;
954
  /// Allocated CRNTI for UE
955
  uint16_t crnti;
956
  /// Total number of PDU errors (diagnostic mode)
957
  uint32_t dci_errors;
958
  /// Total number of PDU received
959
  uint32_t dci_received;
960
  /// Total number of DCI False detection (diagnostic mode)
961
  uint32_t dci_false;
962
  /// Total number of DCI missed (diagnostic mode)
963
  uint32_t dci_missed;
964
  /// nCCE for PUCCH per subframe
965
  uint8_t nCCE[10];
966 967 968 969
} LTE_UE_PDCCH;

#define PBCH_A 24
typedef struct {
970 971 972
  uint8_t pbch_d[96+(3*(16+PBCH_A))];
  uint8_t pbch_w[3*3*(16+PBCH_A)];
  uint8_t pbch_e[1920];
973 974 975
} LTE_eNB_PBCH;

typedef struct {
976 977 978
  /// \brief Pointers to extracted PBCH symbols in frequency-domain.
  /// - first index: rx antenna [0..nb_antennas_rx[
  /// - second index: ? [0..287] (hard coded)
979
  int32_t **rxdataF_ext;
980 981 982
  /// \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)
983
  int32_t **rxdataF_comp;
984 985 986
  /// \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)
987
  int32_t **dl_ch_estimates_ext;
988 989
  /// \brief Pointer to PBCH llrs.
  /// - first index: ? [0..1919] (hard coded)
990
  int8_t *llr;
991 992
  /// \brief Pointer to PBCH decoded output.
  /// - first index: ? [0..63] (hard coded)
993
  uint8_t *decoded_output;
994
  /// \brief Total number of PDU errors.
995
  uint32_t pdu_errors;
996
  /// \brief Total number of PDU errors 128 frames ago.
997
  uint32_t pdu_errors_last;
998
  /// \brief Total number of consecutive PDU errors.
999
  uint32_t pdu_errors_conseq;
1000
  /// \brief FER (in percent) .
1001
  uint32_t pdu_fer;
1002 1003 1004
} LTE_UE_PBCH;

typedef struct {
1005 1006 1007
  int16_t amp;
  int16_t *prachF;
  int16_t *prach;
1008 1009 1010
} LTE_UE_PRACH;

typedef struct {
1011 1012
  /// \brief ?.
  /// first index: ? [0..1023] (hard coded)
1013
  int16_t *prachF;
1014 1015 1016
  /// \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[
1017
  int16_t *rxsigF[4];
1018 1019 1020 1021
  /// \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];
1022 1023 1024 1025
} LTE_eNB_PRACH;

typedef struct {
  /// Preamble index for PRACH (0-63)
1026
  uint8_t ra_PreambleIndex;
1027
  /// RACH MaskIndex
1028
  uint8_t ra_RACH_MaskIndex;
1029
  /// Target received power at eNB (-120 ... -82 dBm)
1030
  int8_t ra_PREAMBLE_RECEIVED_TARGET_POWER;
1031
  /// PRACH index for TDD (0 ... 6) depending on TDD configuration and prachConfigIndex
1032
  uint8_t ra_TDD_map_index;
1033
  /// Corresponding RA-RNTI for UL-grant
1034
  uint16_t ra_RNTI;
1035
  /// Pointer to Msg3 payload for UL-grant
1036
  uint8_t *Msg3;
1037 1038 1039 1040
} PRACH_RESOURCES_t;

typedef struct {
  /// Downlink Power offset field
1041
  uint8_t dl_pow_off;
1042
  ///Subband resource allocation field
1043
  uint8_t rballoc_sub[50];
1044
  ///Total number of PRBs indicator
1045
  uint8_t pre_nb_available_rbs;
1046
} MU_MIMO_mode;
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062

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