defs.h 28.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
 * the OAI Public License, Version 1.0  (the "License"); you may not use this file
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */
21
22
23
24
25
26
27
28
29
30
31
32
33
34

/*! \file PHY/LTE_TRANSPORT/defs.h
* \brief data structures for PDSCH/DLSCH/PUSCH/ULSCH physical and transport channel descriptors (TX/RX)
* \author R. Knopp
* \date 2011
* \version 0.1
* \company Eurecom
* \email: raymond.knopp@eurecom.fr, florian.kaltenberger@eurecom.fr, oscar.tonelli@yahoo.it
* \note
* \warning
*/
#ifndef __LTE_TRANSPORT_DEFS__H__
#define __LTE_TRANSPORT_DEFS__H__
#include "PHY/defs.h"
35
#include "PHY/impl_defs_lte.h"
36
#include "dci.h"
37
#include "mdci.h"
38
#include "uci.h"
knopp's avatar
knopp committed
39
#ifndef STANDALONE_COMPILE
40
#include "UTIL/LISTS/list.h"
knopp's avatar
knopp committed
41
#endif
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

#define MOD_TABLE_QPSK_OFFSET 1
#define MOD_TABLE_16QAM_OFFSET 5
#define MOD_TABLE_64QAM_OFFSET 21
#define MOD_TABLE_PSS_OFFSET 85

// structures below implement 36-211 and 36-212

/** @addtogroup _PHY_TRANSPORT_
 * @{
 */



#define NSOFT 1827072
57
#define LTE_NULL 2
58

59
// maximum of 3 segments before each coding block if data length exceeds 6144 bits.
60
61
62
63
64
65
66
67
68

#define MAX_NUM_DLSCH_SEGMENTS 16
#define MAX_NUM_ULSCH_SEGMENTS MAX_NUM_DLSCH_SEGMENTS
#define MAX_DLSCH_PAYLOAD_BYTES (MAX_NUM_DLSCH_SEGMENTS*768)
#define MAX_ULSCH_PAYLOAD_BYTES (MAX_NUM_ULSCH_SEGMENTS*768)

#define MAX_NUM_CHANNEL_BITS (14*1200*6)  // 14 symbols, 1200 REs, 12 bits/RE
#define MAX_NUM_RE (14*1200)

gauthier's avatar
gauthier committed
69
#if !defined(SI_RNTI)
gauthier's avatar
gauthier committed
70
#define SI_RNTI  (rnti_t)0xffff
gauthier's avatar
gauthier committed
71
72
#endif
#if !defined(M_RNTI)
gauthier's avatar
gauthier committed
73
#define M_RNTI   (rnti_t)0xfffd
gauthier's avatar
gauthier committed
74
75
#endif
#if !defined(P_RNTI)
gauthier's avatar
gauthier committed
76
#define P_RNTI   (rnti_t)0xfffe
gauthier's avatar
gauthier committed
77
78
#endif
#if !defined(CBA_RNTI)
gauthier's avatar
gauthier committed
79
#define CBA_RNTI (rnti_t)0xfff4
gauthier's avatar
gauthier committed
80
81
#endif
#if !defined(C_RNTI)
gauthier's avatar
gauthier committed
82
#define C_RNTI   (rnti_t)0x1234
gauthier's avatar
gauthier committed
83
#endif
Elena Lukashova's avatar
Elena Lukashova committed
84
85
86
// These are the codebook indexes according to Table 6.3.4.2.3-1 of 36.211
//1 layer
#define PMI_2A_11  0
87
#define PMI_2A_1m1 1
Elena Lukashova's avatar
Elena Lukashova committed
88
#define PMI_2A_1j  2
89
#define PMI_2A_1mj 3
Elena Lukashova's avatar
Elena Lukashova committed
90
//2 layers
91
#define PMI_2A_R1_10 0
Elena Lukashova's avatar
Elena Lukashova committed
92
93
94
#define PMI_2A_R1_11 1
#define PMI_2A_R1_1j 2

95
96
typedef enum { SEARCH_EXIST=0,
	       SEARCH_EXIST_OR_FREE} find_type_t;
97
98
99
100
101
102
103
104
105
106
107
108
109
110

typedef enum {
  SCH_IDLE,
  ACTIVE,
  CBA_ACTIVE,
  DISABLED
} SCH_status_t;


typedef struct {
  /// Status Flag indicating for this DLSCH (idle,active,disabled)
  SCH_status_t status;
  /// Transport block size
  uint32_t TBS;
111
112
  /// pointer to pdu from MAC interface (this is "a" in 36.212)
  uint8_t *pdu;
113
114
  /// The payload + CRC size in bits, "B" from 36-212
  uint32_t B;
115
  /// Pointer to the payload
116
  uint8_t *b;
117
  /// Pointers to transport block segments
118
  uint8_t *c[MAX_NUM_DLSCH_SEGMENTS];
119
120
  /// RTC values for each segment (for definition see 36-212 V8.6 2009-03, p.15)
  uint32_t RTC[MAX_NUM_DLSCH_SEGMENTS];
121
122
123
124
  /// Frame where current HARQ round was sent
  uint32_t frame;
  /// Subframe where current HARQ round was sent
  uint32_t subframe;
125
126
  /// Index of current HARQ round for this DLSCH
  uint8_t round;
127
128
129
  /// Modulation order
  uint8_t Qm;
  /// MCS
130
  uint8_t mcs;
131
132
133
134
  /// Redundancy-version of the current sub-frame
  uint8_t rvidx;
  /// MIMO mode for this DLSCH
  MIMO_mode_t mimo_mode;
135
136
  /// Current RB allocation
  uint32_t rb_alloc[4];
137
138
  /// distributed/localized flag
  vrb_t vrb_type;
139
140
141
142
143
144
145
146
147
148
149
150
  /// Current subband PMI allocation
  uint16_t pmi_alloc;
  /// Current subband RI allocation
  uint32_t ri_alloc;
  /// Current subband CQI1 allocation
  uint32_t cqi_alloc1;
  /// Current subband CQI2 allocation
  uint32_t cqi_alloc2;
  /// Current Number of RBs
  uint16_t nb_rb;
  /// downlink power offset field
  uint8_t dl_power_off;
151
152
  /// start symbold of pdsch
  uint8_t pdsch_start;
153
  /// Concatenated "e"-sequences (for definition see 36-212 V8.6 2009-03, p.17-18)
154
  uint8_t e[MAX_NUM_CHANNEL_BITS] __attribute__((aligned(32)));
155
  /// Turbo-code outputs (36-212 V8.6 2009-03, p.12
156
  uint8_t *d[MAX_NUM_DLSCH_SEGMENTS];//[(96+3+(3*6144))];
157
  /// Sub-block interleaver outputs (36-212 V8.6 2009-03, p.16-17)
158
159
160
  uint8_t w[MAX_NUM_DLSCH_SEGMENTS][3*6144];
  /// Number of code segments (for definition see 36-212 V8.6 2009-03, p.9)
  uint32_t C;
161
  /// Number of "small" code segments (for definition see 36-212 V8.6 2009-03, p.10)
162
  uint32_t Cminus;
163
  /// Number of "large" code segments (for definition see 36-212 V8.6 2009-03, p.10)
164
165
166
  uint32_t Cplus;
  /// Number of bits in "small" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Kminus;
167
  /// Number of bits in "large" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
168
  uint32_t Kplus;
169
  /// Number of "Filler" bits (for definition see 36-212 V8.6 2009-03, p.10)
170
  uint32_t F;
171
  /// Number of MIMO layers (streams) (for definition see 36-212 V8.6 2009-03, p.17, TM3-4)
172
  uint8_t Nl;
173
174
175
176
  /// Number of layers for this PDSCH transmission (TM8-10)
  uint8_t Nlayers;
  /// First layer for this PSCH transmission
  uint8_t first_layer;
177
  /// codeword this transport block is mapped to
178
  uint8_t codeword;
179
180
181
} LTE_DL_eNB_HARQ_t;

typedef struct {
182
183
184
185
  /// Indicator of first transmission
  uint8_t first_tx;
  /// Last Ndi received for this process on DCI (used for C-RNTI only)
  uint8_t DCINdi;
186
  /// Flag indicating that this ULSCH has a new packet (start of new round)
187
  //  uint8_t Ndi;
188
189
190
191
192
193
  /// Status Flag indicating for this ULSCH (idle,active,disabled)
  SCH_status_t status;
  /// Subframe scheduling indicator (i.e. Transmission opportunity indicator)
  uint8_t subframe_scheduling_flag;
  /// Subframe cba scheduling indicator (i.e. Transmission opportunity indicator)
  uint8_t subframe_cba_scheduling_flag;
194
  /// First Allocated RB
195
196
197
198
199
200
201
  uint16_t first_rb;
  /// Current Number of RBs
  uint16_t nb_rb;
  /// Last TPC command
  uint8_t TPC;
  /// Transport block size
  uint32_t TBS;
202
203
  /// The payload + CRC size in bits, "B" from 36-212
  uint32_t B;
204
205
206
  /// Length of ACK information (bits)
  uint8_t O_ACK;
  /// Pointer to the payload
207
  uint8_t *b;
208
  /// Pointers to transport block segments
209
  uint8_t *c[MAX_NUM_ULSCH_SEGMENTS];
210
211
  /// RTC values for each segment (for definition see 36-212 V8.6 2009-03, p.15)
  uint32_t RTC[MAX_NUM_ULSCH_SEGMENTS];
212
213
  /// Index of current HARQ round for this ULSCH
  uint8_t round;
214
  /// MCS format of this ULSCH
215
  uint8_t mcs;
216
217
  /// Redundancy-version of the current sub-frame
  uint8_t rvidx;
218
219
  /// Turbo-code outputs (36-212 V8.6 2009-03, p.12
  uint8_t d[MAX_NUM_ULSCH_SEGMENTS][(96+3+(3*6144))];
220
  /// Sub-block interleaver outputs (36-212 V8.6 2009-03, p.16-17)
221
222
223
  uint8_t w[MAX_NUM_ULSCH_SEGMENTS][3*6144];
  /// Number of code segments (for definition see 36-212 V8.6 2009-03, p.9)
  uint32_t C;
224
  /// Number of "small" code segments (for definition see 36-212 V8.6 2009-03, p.10)
225
  uint32_t Cminus;
226
  /// Number of "large" code segments (for definition see 36-212 V8.6 2009-03, p.10)
227
228
229
  uint32_t Cplus;
  /// Number of bits in "small" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Kminus;
230
  /// Number of bits in "large" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
231
  uint32_t Kplus;
232
233
234
  /// Total number of bits across all segments
  uint32_t sumKr;
  /// Number of "Filler" bits (for definition see 36-212 V8.6 2009-03, p.10)
235
  uint32_t F;
236
237
238
239
240
241
242
243
244
245
246
247
  /// Msc_initial, Initial number of subcarriers for ULSCH (36-212, v8.6 2009-03, p.26-27)
  uint16_t Msc_initial;
  /// Nsymb_initial, Initial number of symbols for ULSCH (36-212, v8.6 2009-03, p.26-27)
  uint8_t Nsymb_initial;
  /// n_DMRS  for cyclic shift of DMRS (36.213 Table 9.1.2-2)
  uint8_t n_DMRS;
  /// n_DMRS2 for cyclic shift of DMRS (36.211 Table 5.5.1.1.-1)
  uint8_t n_DMRS2;
  /// Flag to indicate that this is a control only ULSCH (i.e. no MAC SDU)
  uint8_t control_only;
  /// Flag to indicate that this is a calibration ULSCH (i.e. no MAC SDU and filled with TDD calibration information)
  //  int calibration_flag;
Gabriel's avatar
Gabriel committed
248
249
250
251
252
  /// Number of soft channel bits
  uint32_t G;

  // decode phich
  uint8_t decode_phich;
253
} LTE_UL_UE_HARQ_t; 
254

255
256
257
258
259
260
261
#ifdef Rel14
typedef enum {
  CEmodeA = 0,
  CEmodeB = 1
} CEmode_t;
#endif

262
typedef struct {
knopp's avatar
   
knopp committed
263
  /// TX buffers for UE-spec transmission (antenna ports 5 or 7..14, prior to precoding)
Florian Kaltenberger's avatar
Florian Kaltenberger committed
264
  int32_t *txdataF[8];
Xiwen JIANG's avatar
Xiwen JIANG committed
265
  /// beamforming weights for UE-spec transmission (antenna ports 5 or 7..14), for each codeword, maximum 4 layers?
Florian Kaltenberger's avatar
Florian Kaltenberger committed
266
  int32_t **ue_spec_bf_weights[4]; 
267
268
  /// dl channel estimates (estimated from ul channel estimates)
  int32_t **calib_dl_ch_estimates;
269
  /// Allocated RNTI (0 means DLSCH_t is not currently used)
270
  uint16_t rnti;
271
272
  /// Active flag for baseband transmitter processing
  uint8_t active;
273
274
  /// HARQ process mask, indicates which processes are currently active
  uint16_t harq_mask;
275
276
  /// Indicator of TX activation per subframe.  Used during PUCCH detection for ACK/NAK.
  uint8_t subframe_tx[10];
277
  /// First CCE of last PDSCH scheduling per subframe.  Again used during PUCCH detection for ACK/NAK.
278
279
280
281
282
283
284
285
  uint8_t nCCE[10];
  /// Process ID's per subframe.  Used to associate received ACKs on PUSCH/PUCCH to DLSCH harq process ids
  uint8_t harq_ids[10];
  /// Window size (in outgoing transport blocks) for fine-grain rate adaptation
  uint8_t ra_window_size;
  /// First-round error threshold for fine-grain rate adaptation
  uint8_t error_threshold;
  /// Pointers to 8 HARQ processes for the DLSCH
286
  LTE_DL_eNB_HARQ_t *harq_processes[8];
287
288
289
  /// Number of soft channel bits
  uint32_t G;
  /// Codebook index for this dlsch (0,1,2,3)
290
  uint8_t codebook_index;
291
  /// Maximum number of HARQ processes (for definition see 36-212 V8.6 2009-03, p.17)
292
  uint8_t Mdlharq;
293
294
  /// Maximum number of HARQ rounds
  uint8_t Mlimit;
295
296
  /// MIMO transmission mode indicator for this sub-frame (for definition see 36-212 V8.6 2009-03, p.17)
  uint8_t Kmimo;
297
298
  /// Nsoft parameter related to UE Category
  uint32_t Nsoft;
299
  /// amplitude of PDSCH (compared to RS) in symbols without pilots
300
301
302
  int16_t sqrt_rho_a;
  /// amplitude of PDSCH (compared to RS) in symbols containing pilots
  int16_t sqrt_rho_b;
303
304
305
306
307
308
309
#ifdef Rel14
  /// indicator that this DLSCH corresponds to SIB1-BR, needed for c_init for scrambling
  uint8_t sib1_br_flag;
  /// initial absolute subframe (see 36.211 Section 6.3.1), needed for c_init for scrambling
  uint16_t i0;
  CEmode_t CEmode;
#endif
310
311
312
313
314
315
316
317
318
319
320
} LTE_eNB_DLSCH_t;

#define PUSCH_x 2
#define PUSCH_y 3

typedef struct {
  /// Current Number of Symbols
  uint8_t Nsymb_pusch;
  /// SRS active flag
  uint8_t srs_active;
  /// Pointers to 8 HARQ processes for the ULSCH
321
  LTE_UL_UE_HARQ_t *harq_processes[8];
322
323
324
325
  /// Pointer to CQI data
  uint8_t o[MAX_CQI_BYTES];
  /// Length of CQI data (bits)
  uint8_t O;
326
  /// Format of CQI data
327
  UCI_format_t uci_format;
328
  /// Rank information
329
330
331
332
333
334
335
336
337
  uint8_t o_RI[2];
  /// Length of rank information (bits)
  uint8_t O_RI;
  /// Pointer to ACK
  uint8_t o_ACK[4];
  /// Minimum number of CQI bits for PUSCH (36-212 r8.6, Sec 5.2.4.1 p. 37)
  uint8_t O_CQI_MIN;
  /// ACK/NAK Bundling flag
  uint8_t bundling;
338
  /// Concatenated "e"-sequences (for definition see 36-212 V8.6 2009-03, p.17-18)
339
  uint8_t e[MAX_NUM_CHANNEL_BITS];
340
  /// Interleaved "h"-sequences (for definition see 36-212 V8.6 2009-03, p.17-18)
341
  uint8_t h[MAX_NUM_CHANNEL_BITS];
342
  /// Scrambled "b"-sequences (for definition see 36-211 V8.6 2009-03, p.14)
343
  uint8_t b_tilde[MAX_NUM_CHANNEL_BITS];
344
  /// Modulated "d"-sequences (for definition see 36-211 V8.6 2009-03, p.14)
345
  int32_t d[MAX_NUM_RE];
346
  /// Transform-coded "z"-sequences (for definition see 36-211 V8.6 2009-03, p.14-15)
347
  int32_t z[MAX_NUM_RE];
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
  /// "q" sequences for CQI/PMI (for definition see 36-212 V8.6 2009-03, p.27)
  uint8_t q[MAX_CQI_PAYLOAD];
  /// coded and interleaved CQI bits
  uint8_t o_w[(MAX_CQI_BITS+8)*3];
  /// coded CQI bits
  uint8_t o_d[96+((MAX_CQI_BITS+8)*3)];
  /// coded ACK bits
  uint8_t q_ACK[MAX_ACK_PAYLOAD];
  /// coded RI bits
  uint8_t q_RI[MAX_RI_PAYLOAD];
  /// beta_offset_cqi times 8
  uint16_t beta_offset_cqi_times8;
  /// beta_offset_ri times 8
  uint16_t beta_offset_ri_times8;
  /// beta_offset_harqack times 8
  uint16_t beta_offset_harqack_times8;
  /// power_offset
  uint8_t power_offset;
  // for cooperative communication
  uint8_t cooperation_flag;
  /// RNTI attributed to this ULSCH
  uint16_t rnti;
  /// f_PUSCH parameter for PUSCH power control
  int16_t f_pusch;
  /// Po_PUSCH - target output power for PUSCH
  int16_t Po_PUSCH;
  /// PHR - current power headroom (based on last PUSCH transmission)
  int16_t PHR;
Bilel's avatar
Bilel committed
376
377
  /// Po_SRS - target output power for SRS
  int16_t Po_SRS;
378
  /// num active cba group
379
380
381
382
383
  uint8_t num_active_cba_groups;
  /// num dci found for cba
  uint8_t num_cba_dci[10];
  /// allocated CBA RNTI
  uint16_t cba_rnti[4];//NUM_MAX_CBA_GROUP];
Bilel's avatar
Bilel committed
384
385
  /// UL max-harq-retransmission
  uint8_t Mlimit;
386
387
388
389
390
391
392
393
394
} LTE_UE_ULSCH_t;

typedef struct {
  /// Flag indicating that this ULSCH has been allocated by a DCI (otherwise it is a retransmission based on PHICH NAK)
  uint8_t dci_alloc;
  /// Flag indicating that this ULSCH has been allocated by a RAR (otherwise it is a retransmission based on PHICH NAK or DCI)
  uint8_t rar_alloc;
  /// Status Flag indicating for this ULSCH (idle,active,disabled)
  SCH_status_t status;
395
396
397
398
399
400
  /// Flag to indicate that eNB should decode UE Msg3
  uint8_t Msg3_flag;
  /// Subframe for reception
  uint8_t subframe;
  /// Frame for reception
  uint32_t frame;
401
402
403
404
  /// PHICH active flag
  uint8_t phich_active;
  /// PHICH ACK
  uint8_t phich_ACK;
405
  /// First Allocated RB
406
  uint16_t first_rb;
Cedric Roux's avatar
Cedric Roux committed
407
408
409
410
  /// First Allocated RB - previous scheduling
  /// This is needed for PHICH generation which
  /// is done after a new scheduling
  uint16_t previous_first_rb;
411
  /// Current Number of RBs
412
413
414
  uint16_t nb_rb; 
  /// Current Modulation order
  uint8_t Qm;
415
416
  /// Transport block size
  uint32_t TBS;
417
418
  /// The payload + CRC size in bits
  uint32_t B;
419
420
  /// Number of soft channel bits
  uint32_t G;
knopp's avatar
   
knopp committed
421
422
423
424
  /// CQI CRC status
  uint8_t cqi_crc_status;
  /// Pointer to CQI data
  uint8_t o[MAX_CQI_BYTES];
425
  /// Format of CQI data
knopp's avatar
   
knopp committed
426
427
428
429
430
  UCI_format_t uci_format;
  /// Length of CQI data under RI=1 assumption(bits)
  uint8_t Or1;
  /// Length of CQI data under RI=2 assumption(bits)
  uint8_t Or2;
431
  /// Rank information
knopp's avatar
   
knopp committed
432
433
434
435
436
  uint8_t o_RI[2];
  /// Length of rank information (bits)
  uint8_t O_RI;
  /// Pointer to ACK
  uint8_t o_ACK[4];
437
438
  /// Length of ACK information (bits)
  uint8_t O_ACK;
439
  /// The value of DAI in DCI format 0
440
  uint8_t V_UL_DAI;
knopp's avatar
   
knopp committed
441
442
443
444
445
446
447
448
449
450
451
452
  /// "q" sequences for CQI/PMI (for definition see 36-212 V8.6 2009-03, p.27)
  int8_t q[MAX_CQI_PAYLOAD];
  /// number of coded CQI bits after interleaving
  uint8_t o_RCC;
  /// coded and interleaved CQI bits
  int8_t o_w[(MAX_CQI_BITS+8)*3];
  /// coded CQI bits
  int8_t o_d[96+((MAX_CQI_BITS+8)*3)];
  /// coded ACK bits
  int16_t q_ACK[MAX_ACK_PAYLOAD];
  /// coded RI bits
  int16_t q_RI[MAX_RI_PAYLOAD];
453
  /// Concatenated "e"-sequences (for definition see 36-212 V8.6 2009-03, p.17-18)
454
  int16_t e[MAX_NUM_CHANNEL_BITS] __attribute__((aligned(32)));
knopp's avatar
   
knopp committed
455
456
  /// Temporary h sequence to flag PUSCH_x/PUSCH_y symbols which are not scrambled
  uint8_t h[MAX_NUM_CHANNEL_BITS];
457
  /// Pointer to the payload
458
  uint8_t *b;
459
460
  /// Pointers to transport block segments
  uint8_t *c[MAX_NUM_ULSCH_SEGMENTS];
461
462
  /// RTC values for each segment (for definition see 36-212 V8.6 2009-03, p.15)
  uint32_t RTC[MAX_NUM_ULSCH_SEGMENTS];
knopp's avatar
   
knopp committed
463
464
465
466
  /// Current Number of Symbols
  uint8_t Nsymb_pusch;
  /// SRS active flag
  uint8_t srs_active;
467
  /// Index of current HARQ round for this ULSCH
468
  uint8_t round;
469
470
  /// Redundancy-version of the current sub-frame
  uint8_t rvidx;
471
  /// soft bits for each received segment ("w"-sequence)(for definition see 36-212 V8.6 2009-03, p.15)
472
  int16_t w[MAX_NUM_ULSCH_SEGMENTS][3*(6144+64)];
473
  /// soft bits for each received segment ("d"-sequence)(for definition see 36-212 V8.6 2009-03, p.15)
474
  int16_t *d[MAX_NUM_ULSCH_SEGMENTS];
475
476
  /// Number of code segments (for definition see 36-212 V8.6 2009-03, p.9)
  uint32_t C;
477
  /// Number of "small" code segments (for definition see 36-212 V8.6 2009-03, p.10)
478
479
480
481
482
483
  uint32_t Cminus;
  /// Number of "large" code segments (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Cplus;
  /// Number of bits in "small" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Kminus;
  /// Number of bits in "large" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
484
  uint32_t Kplus;
485
486
  /// Number of "Filler" bits (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t F;
487
  /// Number of MIMO layers (streams) (for definition see 36-212 V8.6 2009-03, p.17)
488
  uint8_t Nl;
489
490
491
492
493
494
  /// Msc_initial, Initial number of subcarriers for ULSCH (36-212, v8.6 2009-03, p.26-27)
  uint16_t Msc_initial;
  /// Nsymb_initial, Initial number of symbols for ULSCH (36-212, v8.6 2009-03, p.26-27)
  uint8_t Nsymb_initial;
  /// n_DMRS  for cyclic shift of DMRS (36.213 Table 9.1.2-2)
  uint8_t n_DMRS;
Cedric Roux's avatar
Cedric Roux committed
495
496
497
498
  /// n_DMRS  for cyclic shift of DMRS (36.213 Table 9.1.2-2) - previous scheduling
  /// This is needed for PHICH generation which
  /// is done after a new scheduling
  uint8_t previous_n_DMRS;
499
500
501
502
  /// n_DMRS 2 for cyclic shift of DMRS (36.211 Table 5.5.1.1.-1)
  uint8_t n_DMRS2;
  /// Flag to indicate that this ULSCH is for calibration information sent from UE (i.e. no MAC SDU to pass up)
  //  int calibration_flag;
503
504
  /// delta_TF for power control
  int32_t delta_TF;
505
506
} LTE_UL_eNB_HARQ_t;

507
508
509
510
511

typedef enum {
  pucch_format1=0,
  pucch_format1a,
  pucch_format1b,
512
513
514
  pucch_format1b_csA2,
  pucch_format1b_csA3,
  pucch_format1b_csA4,
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
  pucch_format2,
  pucch_format2a,
  pucch_format2b,
  pucch_format3    // PUCCH format3
} PUCCH_FMT_t;

typedef enum {
  SR,
  HARQ,
  CQI,
  HARQ_SR,
  HARQ_CQI,
  SR_CQI,
  HARQ_SR_CQI  
} UCI_type_t;

#ifdef Rel14
typedef enum {
  NOCE,
  CEMODEA,
  CEMODEB
} UE_type_t;
#endif

typedef struct {
  uint8_t     active;
  /// Absolute frame for this UCI
  uint16_t    frame;
  /// Absolute subframe for this UCI
  uint8_t     subframe;
  /// corresponding UE RNTI
  uint16_t    rnti;
  /// Type (SR,HARQ,CQI,HARQ_SR,HARQ_CQI,SR_CQI,HARQ_SR_CQI)
  UCI_type_t  type;
549
550
  /// SRS active flag
  uint8_t     srs_active;
551
552
  /// PUCCH format to use
  PUCCH_FMT_t pucch_fmt;
553
554
555
  /// number of PUCCH antenna ports 
  uint8_t     num_antenna_ports;
  /// number of PUCCH resources
556
  uint8_t     num_pucch_resources;
557
558
559
560
561
  /// two antenna n1_pucch 1_0
  uint16_t    n_pucch_1[4][2];
  /// two antenna n1_pucch 1_0 for SR
  uint16_t    n_pucch_1_0_sr[2];
   /// two antenna n2_pucch
562
  uint16_t    n_pucch_2[2];
563
564
565
566
  /// two antenna n3_pucch
  uint16_t    n_pucch_3[2];
  /// TDD Bundling/multiplexing flag
  uint8_t     tdd_bundling;
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
#ifdef Rel14
  /// non BL/CE, CEmodeA, CEmodeB
  UE_type_t ue_type;
  /// Indicates the symbols that are left empty due to eMTC retuning.
  uint8_t empty_symbols;
  /// number of repetitions for BL/CE
  uint16_t total_repetitions;
  /// The size of the DL CQI/PMI in bits.
  uint16_t dl_cqi_pmi_size2;
  /// The starting PRB for the PUCCH
  uint8_t starting_prb;
  /// The number of PRB in PUCCH
  uint8_t n_PRB;
  /// Selected CDM option
  uint8_t cdm_Index;
  // Indicates if the resource blocks allocated for this grant overlap with the SRS configuration.
  uint8_t Nsrs;
#endif
585
} LTE_eNB_UCI;
586

587
typedef struct {
588
589
  /// HARQ process mask, indicates which processes are currently active
  uint16_t harq_mask;
590
  /// Pointers to 8 HARQ processes for the ULSCH
591
  LTE_UL_eNB_HARQ_t *harq_processes[8];
592
593
  /// Maximum number of HARQ rounds
  uint8_t Mlimit;
594
595
596
597
598
599
600
601
602
603
  /// Maximum number of iterations used in eNB turbo decoder
  uint8_t max_turbo_iterations;
  /// ACK/NAK Bundling flag
  uint8_t bundling;
  /// beta_offset_cqi times 8
  uint16_t beta_offset_cqi_times8;
  /// beta_offset_ri times 8
  uint16_t beta_offset_ri_times8;
  /// beta_offset_harqack times 8
  uint16_t beta_offset_harqack_times8;
604
  /// Flag to indicate that eNB awaits UE Msg3
605
606
607
608
609
610
611
  uint8_t Msg3_active;
  /// RNTI attributed to this ULSCH
  uint16_t rnti;
  /// cyclic shift for DM RS
  uint8_t cyclicShift;
  /// cooperation flag
  uint8_t cooperation_flag;
612
  /// num active cba group
613
614
615
  uint8_t num_active_cba_groups;
  /// allocated CBA RNTI for this ulsch
  uint16_t cba_rnti[4];//NUM_MAX_CBA_GROUP];
616
617
618
619
#ifdef LOCALIZATION
  /// epoch timestamp in millisecond
  int32_t reference_timestamp_ms;
  /// aggregate physical states every n millisecond
620
  int32_t aggregation_period_ms;
621
  /// a set of lists used for localization
622
623
  struct list loc_rss_list[10], loc_rssi_list[10], loc_subcarrier_rss_list[10], loc_timing_advance_list[10], loc_timing_update_list[10];
  struct list tot_loc_rss_list, tot_loc_rssi_list, tot_loc_subcarrier_rss_list, tot_loc_timing_advance_list, tot_loc_timing_update_list;
624
#endif
625
626
627
} LTE_eNB_ULSCH_t;

typedef struct {
628
629
630
631
  /// Indicator of first transmission
  uint8_t first_tx;
  /// Last Ndi received for this process on DCI (used for C-RNTI only)
  uint8_t DCINdi;
632
  /// DLSCH status flag indicating
633
634
635
  SCH_status_t status;
  /// Transport block size
  uint32_t TBS;
636
637
  /// The payload + CRC size in bits
  uint32_t B;
638
  /// Pointer to the payload
639
  uint8_t *b;
640
641
  /// Pointers to transport block segments
  uint8_t *c[MAX_NUM_DLSCH_SEGMENTS];
642
643
  /// RTC values for each segment (for definition see 36-212 V8.6 2009-03, p.15)
  uint32_t RTC[MAX_NUM_DLSCH_SEGMENTS];
644
  /// Index of current HARQ round for this DLSCH
645
  uint8_t round;
646
  /// MCS format for this DLSCH
647
  uint8_t mcs;
648
649
  /// Qm (modulation order) for this DLSCH
  uint8_t Qm;
650
651
652
653
  /// Redundancy-version of the current sub-frame
  uint8_t rvidx;
  /// MIMO mode for this DLSCH
  MIMO_mode_t mimo_mode;
654
  /// soft bits for each received segment ("w"-sequence)(for definition see 36-212 V8.6 2009-03, p.15)
655
  int16_t w[MAX_NUM_DLSCH_SEGMENTS][3*(6144+64)];
656
  /// for abstraction soft bits for each received segment ("w"-sequence)(for definition see 36-212 V8.6 2009-03, p.15)
657
  double w_abs[MAX_NUM_DLSCH_SEGMENTS][3*(6144+64)];
658
  /// soft bits for each received segment ("d"-sequence)(for definition see 36-212 V8.6 2009-03, p.15)
659
  int16_t *d[MAX_NUM_DLSCH_SEGMENTS];
660
661
  /// Number of code segments (for definition see 36-212 V8.6 2009-03, p.9)
  uint32_t C;
662
  /// Number of "small" code segments (for definition see 36-212 V8.6 2009-03, p.10)
663
664
665
666
667
668
  uint32_t Cminus;
  /// Number of "large" code segments (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Cplus;
  /// Number of bits in "small" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t Kminus;
  /// Number of bits in "large" code segments (<6144) (for definition see 36-212 V8.6 2009-03, p.10)
669
  uint32_t Kplus;
670
671
  /// Number of "Filler" bits (for definition see 36-212 V8.6 2009-03, p.10)
  uint32_t F;
672
673
674
  /// Number of MIMO layers (streams) (for definition see 36-212 V8.6 2009-03, p.17)
  uint8_t Nl;
  /// current delta_pucch
gauthier's avatar
gauthier committed
675
  int8_t delta_PUCCH;
676
677
678
679
680
681
  /// Number of soft channel bits
  uint32_t G;
  /// Current Number of RBs
  uint16_t nb_rb;
  /// Current subband PMI allocation
  uint16_t pmi_alloc;
682
683
684
685
686
687
  /// Current RB allocation (even slots)
  uint32_t rb_alloc_even[4];
  /// Current RB allocation (odd slots)
  uint32_t rb_alloc_odd[4];
  /// distributed/localized flag
  vrb_t vrb_type;
688
689
  /// downlink power offset field
  uint8_t dl_power_off;
690
691
692
693
  /// trials per round statistics
  uint32_t trials[8];
  /// error statistics per round
  uint32_t errors[8];
694
695
  /// codeword this transport block is mapped to
  uint8_t codeword;
696
697
} LTE_DL_UE_HARQ_t;

698
typedef struct {
699
700
701
702
  /// time-based localization, relying on TA and TOA
  double time_based;
  /// power-based localization, relying on RSS and RSSI
  double power_based;
703
} eNB_UE_estimated_distances;
704
705
706

typedef struct {
  /// UL RSSI per receive antenna
gauthier's avatar
gauthier committed
707
  int32_t UL_rssi[NB_ANTENNAS_RX];
knopp's avatar
knopp committed
708
  /// PUCCH1a/b power (digital linear)
709
  uint32_t Po_PUCCH;
knopp's avatar
knopp committed
710
711
712
  /// PUCCH1a/b power (dBm)
  int32_t Po_PUCCH_dBm;
  /// PUCCH1 power (digital linear), conditioned on below threshold
713
  uint32_t Po_PUCCH1_below;
knopp's avatar
knopp committed
714
  /// PUCCH1 power (digital linear), conditioned on above threshold
715
  uint32_t Po_PUCCH1_above;
knopp's avatar
knopp committed
716
717
  /// Indicator that Po_PUCCH has been updated by PHY
  int32_t Po_PUCCH_update;
718
719
720
721
722
723
724
725
726
727
728
729
730
  /// DL Wideband CQI index (2 TBs)
  uint8_t DL_cqi[2];
  /// DL Subband CQI index (from HLC feedback)
  uint8_t DL_subband_cqi[2][13];
  /// DL PMI Single Stream
  uint16_t DL_pmi_single;
  /// DL PMI Dual Stream
  uint16_t DL_pmi_dual;
  /// Current RI
  uint8_t rank;
  /// CRNTI of UE
  uint16_t crnti; ///user id (rnti) of connected UEs
  /// Initial timing offset estimate from PRACH for RAR
731
  int32_t UE_timing_offset;
732
  /// Timing advance estimate from PUSCH for MAC timing advance signalling
733
  int32_t timing_advance_update;
734
735
736
737
  /// Current mode of UE (NOT SYCHED, RAR, PUSCH)
  UE_MODE_t mode;
  /// Current sector where UE is attached
  uint8_t sector;
738

Florian Kaltenberger's avatar
Florian Kaltenberger committed
739
740
  /// dlsch l2 errors
  uint32_t dlsch_l2_errors[8];
741
  /// dlsch trials per harq and round
Florian Kaltenberger's avatar
Florian Kaltenberger committed
742
743
744
745
746
747
748
749
  uint32_t dlsch_trials[8][8];
  /// dlsch ACK/NACK per hard_pid and round
  uint32_t dlsch_ACK[8][8];
  uint32_t dlsch_NAK[8][8];

  /// ulsch l2 errors per harq_pid
  uint32_t ulsch_errors[8];
  /// ulsch l2 consecutive errors per harq_pid
750
  uint32_t ulsch_consecutive_errors; //[8];
Florian Kaltenberger's avatar
Florian Kaltenberger committed
751
752
753
754
755
756
  /// ulsch trials/errors/fer per harq and round
  uint32_t ulsch_decoding_attempts[8][8];
  uint32_t ulsch_round_errors[8][8];
  uint32_t ulsch_decoding_attempts_last[8][8];
  uint32_t ulsch_round_errors_last[8][8];
  uint32_t ulsch_round_fer[8][8];
757
758
759
  uint32_t sr_received;
  uint32_t sr_total;

Florian Kaltenberger's avatar
Florian Kaltenberger committed
760
761
762
  /// dlsch sliding count and total errors in round 0 are used to compute the dlsch_mcs_offset
  uint32_t dlsch_sliding_cnt;
  uint32_t dlsch_NAK_round0;
gauthier's avatar
gauthier committed
763
  int8_t dlsch_mcs_offset;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
764

765
766
767
768
  /// Target mcs1 after rate-adaptation (used by MAC layer scheduler)
  uint8_t dlsch_mcs1;
  /// Target mcs2 after rate-adaptation (used by MAC layer scheduler)
  uint8_t dlsch_mcs2;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
769
770
771
  /// Total bits received from MAC on PDSCH
  int total_TBS_MAC;
  /// Total bits acknowledged on PDSCH
772
  int total_TBS;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
773
  /// Total bits acknowledged on PDSCH (last interval)
774
  int total_TBS_last;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
775
  /// Bitrate on the PDSCH [bps]
776
  unsigned int dlsch_bitrate;
Florian Kaltenberger's avatar
Florian Kaltenberger committed
777
  //  unsigned int total_transmitted_bits;
778
779
780
781
#ifdef LOCALIZATION
  eNB_UE_estimated_distances distance;
  int32_t *subcarrier_rssi;
#endif
782
783
784
785
786
} LTE_eNB_UE_stats;

typedef struct {
  /// HARQ process id
  uint8_t harq_id;
787
  /// ACK bits (after decoding) 0:NACK / 1:ACK / 2:DTX
788
789
790
791
792
  uint8_t ack;
  /// send status (for PUCCH)
  uint8_t send_harq_status;
  /// nCCE (for PUCCH)
  uint8_t nCCE;
793
794
795
796
  /// DAI value detected from DCI1/1a/1b/1d/2/2a/2b/2c. 0xff indicates not touched
  uint8_t vDAI_DL;
  /// DAI value detected from DCI0/4. 0xff indicates not touched
  uint8_t vDAI_UL;
797
798
799
800
801
802
803
804
805
806
807
808
809
} harq_status_t;

typedef struct {
  /// RNTI
  uint16_t rnti;
  /// Active flag for DLSCH demodulation
  uint8_t active;
  /// Transmission mode
  uint8_t mode1_flag;
  /// amplitude of PDSCH (compared to RS) in symbols without pilots
  int16_t sqrt_rho_a;
  /// amplitude of PDSCH (compared to RS) in symbols containing pilots
  int16_t sqrt_rho_b;
Bilel's avatar
Bilel committed
810
  /// Current HARQ process id threadRx Odd and threadRx Even
811
812
813
814
815
816
817
818
819
  uint8_t current_harq_pid;
  /// Current subband antenna selection
  uint32_t antenna_alloc;
  /// Current subband RI allocation
  uint32_t ri_alloc;
  /// Current subband CQI1 allocation
  uint32_t cqi_alloc1;
  /// Current subband CQI2 allocation
  uint32_t cqi_alloc2;
820
821
  /// saved subband PMI allocation from last PUSCH/PUCCH report
  uint16_t pmi_alloc;
822
823
824
  /// HARQ-ACKs
  harq_status_t harq_ack[10];
  /// Pointers to up to 8 HARQ processes
825
  LTE_DL_UE_HARQ_t *harq_processes[8];
826
  /// Maximum number of HARQ processes(for definition see 36-212 V8.6 2009-03, p.17
827
  uint8_t Mdlharq;
828
829
  /// MIMO transmission mode indicator for this sub-frame (for definition see 36-212 V8.6 2009-03, p.17)
  uint8_t Kmimo;
830
831
  /// Nsoft parameter related to UE Category
  uint32_t Nsoft;
832
833
  /// Maximum number of Turbo iterations
  uint8_t max_turbo_iterations;
834
835
  /// number of iterations used in last turbo decoding
  uint8_t last_iteration_cnt;
836
837
  /// accumulated tx power adjustment for PUCCH
  int8_t               g_pucch;
838
839
} LTE_UE_DLSCH_t;

840

841
842
843
844

typedef enum {
  SI_PDSCH=0,
  RA_PDSCH,
845
  P_PDSCH,
846
  PDSCH,
847
  PDSCH1,
848
849
850
  PMCH
} PDSCH_t;

851
852
853
854
typedef enum {
  rx_standard=0,
  rx_IC_single_stream,
  rx_IC_dual_stream,
Elena Lukashova's avatar
Elena Lukashova committed
855
  rx_SIC_dual_stream
856
857
} RX_type_t;

858
859
860
861
862
863




/**@}*/
#endif