impl_defs_lte.h 45.5 KB
Newer Older
1
/*******************************************************************************
ghaddab's avatar
ghaddab committed
2 3
    OpenAirInterface 
    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 17 18 19
    You should have received a copy of the GNU General Public License
    along with OpenAirInterface.The full GNU General Public License is 
   included in this distribution in the file called "COPYING". If not, 
   see <http://www.gnu.org/licenses/>.
20 21

  Contact Information
ghaddab's avatar
ghaddab committed
22 23 24 25
  OpenAirInterface Admin: openair_admin@eurecom.fr
  OpenAirInterface Tech : openair_tech@eurecom.fr
  OpenAirInterface Dev  : openair4g-devel@eurecom.fr
  
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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

/*! \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 "spec_defs_top.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
#define TX_RX_SWITCH_SYMBOL (NUMBER_OF_SYMBOLS_PER_FRAME>>1) 
#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;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

385
/// Union for \ref TPC_PDCCH_CONFIG::tpc_Index.
386
typedef union {
387
    /// Index of N when DCI format 3 is used. See TS 36.212 (5.3.3.1.6). \vr{[1..15]}
388
    uint8_t indexOfFormat3;
389
    /// Index of M when DCI format 3A is used. See TS 36.212 (5.3.3.1.7). \vr{[1..31]}
390
    uint8_t indexOfFormat3A;
391 392
} TPC_INDEX_t;

393
/// TPC-PDCCH-Config Information Element from 36.331 RRC spec
394 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 485 486
  /// 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)
  lte_prefix_type_t Ncp_UL;                   
  /// 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
  /// Size of FFT  
519
  uint16_t ofdm_symbol_size;
520
  /// log2(Size of FFT)  
521
  uint8_t log2_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;
532
  /// Number of Transmit antennas in node
533
  uint8_t nb_antennas_tx;
534
  /// Number of Receive antennas in node
535
  uint8_t nb_antennas_rx;
536
  /// Number of Transmit antennas in eNodeB
537
  uint8_t nb_antennas_tx_eNB;
538
  /// Pointer to twiddle factors for FFT
539
  int16_t *twiddle_fft;
540
  ///pointer to twiddle factors for IFFT
541
  int16_t *twiddle_ifft;
542
  ///pointer to FFT permutation vector
543
  uint16_t *rev;
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
  /// 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;
560
  /// Array of MBSFN Configurations (max 8 (maxMBSFN-Allocations) elements as per 36.331)
561 562
  MBSFN_config_t MBSFN_config[8];
  /// Maximum Number of Retransmissions of RRCConnectionRequest (from 36-331 RRC Spec)
563
  uint8_t maxHARQ_Msg3Tx;
564
  /// Size of SI windows used for repetition of one SI message (in frames)
565
  uint8_t SIwindowsize;
566
  /// Period of SI windows used for repetition of one SI message (in frames)
567
  uint16_t SIPeriod;
568
  /// REGs assigned to PCFICH
569
  uint16_t pcfich_reg[4];
570
  /// Index of first REG assigned to PCFICH
571
  uint8_t pcfich_first_reg_idx;
572
  /// REGs assigned to PHICH
573
  uint16_t phich_reg[MAX_NUM_PHICH_GROUPS][3];
574 575 576 577 578 579

  struct MBSFN_SubframeConfig *mbsfn_SubframeConfig[MAX_MBSFN_AREA];

} LTE_DL_FRAME_PARMS;

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

typedef struct{
602 603 604 605 606
  /// \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:
607
  int32_t **txdata[3];
608 609 610 611 612
  /// \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..]
613
  mod_sym_t **txdataF[3];    
614 615 616 617 618
  /// \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..]
619
  int32_t **rxdata[3];
620 621 622 623
  /// \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[
624
  int32_t **rxdata_7_5kHz[3];
625 626 627 628
  /// \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[
629
  int32_t **rxdataF[3];
630 631 632
  /// \brief Holds output of the sync correlator.
  /// - first index: eNB id [0..2] (hard coded)
  /// - second index: sample [0..samples_per_tti*10[
633
  uint32_t *sync_corr[3];
634 635 636
} LTE_eNB_COMMON;

typedef struct{
637 638 639 640
  /// \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[
641
  int32_t **srs_ch_estimates[3];
642 643 644 645
  /// \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[
646
  int32_t **srs_ch_estimates_time[3];
647 648
  /// \brief Holds the SRS for channel estimation at the RX.
  /// - first index: ? [0..ofdm_symbol_size[
649
  int32_t *srs;
650 651 652
} LTE_eNB_SRS;

typedef struct{
653 654 655 656 657 658
  /// \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
659
  int32_t **rxdataF_ext[3];
660 661 662 663
  /// \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[
664
  int32_t **rxdataF_ext2[3];
665 666 667 668
  /// \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[
669
  int32_t **drs_ch_estimates_time[3];
670 671 672 673
  /// \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[
674
  int32_t **drs_ch_estimates[3];
675 676 677 678
  /// \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[
679
  int32_t **drs_ch_estimates_0[3];
680 681 682 683
  /// \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[
684
  int32_t **drs_ch_estimates_1[3];
685 686 687 688
  /// \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[
689
  int32_t **rxdataF_comp[3];
690 691 692 693
  /// \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[
694
  int32_t **rxdataF_comp_0[3];
695 696 697 698
  /// \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[
699
  int32_t **rxdataF_comp_1[3];
700 701 702 703
  /// \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[
704
  int32_t **ul_ch_mag[3];
705 706 707 708
  /// \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[
709
  int32_t **ul_ch_magb[3];
710 711 712 713
  /// \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[
714
  int32_t **ul_ch_mag_0[3];
715 716 717 718
  /// \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[
719
  int32_t **ul_ch_magb_0[3];
720 721 722 723
  /// \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[
724
  int32_t **ul_ch_mag_1[3];
725 726 727 728
  /// \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[
729
  int32_t **ul_ch_magb_1[3];
730 731 732 733 734 735
  /// 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];
736 737
  /// \brief llr values.
  /// - first index: ? [0..1179743] (hard coded)
738
  int16_t *llr;
739 740 741 742 743 744
#ifdef LOCALIZATION
  /// number of active subcarrier for a specific UE
  int32_t active_subcarrier;
  /// subcarrier power in dBm
  int32_t *subcarrier_power;
#endif
745 746 747
} LTE_eNB_PUSCH;

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

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

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

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

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

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

typedef struct {
1003 1004 1005
  int16_t amp;
  int16_t *prachF;
  int16_t *prach;
1006 1007 1008
} LTE_UE_PRACH;

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

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

typedef struct {
  /// Downlink Power offset field
1035
  uint8_t dl_pow_off;
1036
  ///Subband resource allocation field
1037
  uint8_t rballoc_sub[50];
1038
  ///Total number of PRBs indicator
1039
  uint8_t pre_nb_available_rbs;
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
}MU_MIMO_mode;

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