defs.h 30.7 KB
Newer Older
1 2 3 4 5
/*
 * 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
Cedric Roux's avatar
Cedric Roux committed
6
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * 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
/*! \file RRC/LITE/defs.h
nikaeinn's avatar
nikaeinn committed
23 24 25
* \brief RRC struct definitions and function prototypes
* \author Navid Nikaein and Raymond Knopp
* \date 2010 - 2014
26 27
* \version 1.0
* \company Eurecom
28
* \email: navid.nikaein@eurecom.fr, raymond.knopp@eurecom.fr
29 30 31 32 33 34 35 36 37
*/

#ifndef __OPENAIR_RRC_DEFS_H__
#define __OPENAIR_RRC_DEFS_H__

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

38
#include "collection/tree.h"
winckel's avatar
winckel committed
39
#include "rrc_types.h"
40
#include "PHY/defs.h"
41 42
#include "LAYER2/RLC/rlc.h"

43
#include "COMMON/platform_constants.h"
44
#include "COMMON/platform_types.h"
45 46 47

#include "LAYER2/MAC/defs.h"

Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
48
//for D2D
49
#define DEBUG_CTRL_SOCKET
50
#define BUFSIZE                1024
51
#define CONTROL_SOCKET_PORT_NO 8888
52
#define MAX_NUM_DEST           10
53 54
//netlink
//#define DEBUG_PDCP
55 56 57 58 59
#define UE_IP_PDCP_NETLINK_ID  31
#define PDCP_PID               1
#define NETLINK_HEADER_SIZE    16
#define SL_DEFAULT_RAB_ID      3
#define SLRB_ID                3
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

#define MAX_PAYLOAD 1024 /* maximum payload size*/

#define UE_STATE_NOTIFICATION_INTERVAL      50

#define IPV4_ADDR    "%u.%u.%u.%u"
#define IPV4_ADDR_FORMAT(aDDRESS)                 \
      (uint8_t)((aDDRESS)  & 0x000000ff),         \
      (uint8_t)(((aDDRESS) & 0x0000ff00) >> 8 ),  \
      (uint8_t)(((aDDRESS) & 0x00ff0000) >> 16),  \
      (uint8_t)(((aDDRESS) & 0xff000000) >> 24)


//-----------------------------------------------------
// header for Control socket

//Primitives
#define SESSION_INIT_REQ                    1
#define UE_STATUS_INFO                      2
#define GROUP_COMMUNICATION_ESTABLISH_REQ   3
#define GROUP_COMMUNICATION_ESTABLISH_RSP   4
#define DIRECT_COMMUNICATION_ESTABLISH_REQ  5
#define DIRECT_COMMUNICATION_ESTABLISH_RSP  6
#define GROUP_COMMUNICATION_RELEASE_REQ     7
#define GROUP_COMMUNICATION_RELEASE_RSP     8
85 86
#define PC5S_ESTABLISH_REQ                  9
#define PC5S_ESTABLISH_RSP                  10
87
#define PC5_DISCOVERY_MESSAGE          	  11
88 89 90


#define PC5_DISCOVERY_PAYLOAD_SIZE	    29
91

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

typedef enum {
   UE_STATE_OFF_NETWORK,
   UE_STATE_ON_NETWORK
} SL_UE_STATE_t;

typedef enum {
   GROUP_COMMUNICATION_RELEASE_OK = 0,
   GROUP_COMMUNICATION_RELEASE_FAILURE
} Group_Communication_Status_t;

struct GroupCommunicationEstablishReq {
   uint32_t sourceL2Id;
   uint32_t groupL2Id;
   uint32_t groupIpAddress;
   uint8_t pppp;
};

110 111 112 113 114 115
struct GroupCommunicationReleaseReq {
   uint32_t sourceL2Id;
   uint32_t groupL2Id;
   int slrb_id;
};

116 117 118
struct DirectCommunicationEstablishReq {
   uint32_t sourceL2Id;
   uint32_t destinationL2Id;
119
   uint32_t pppp;
120 121
};

122
struct PC5SEstablishReq{
123
   uint8_t type;
124 125 126 127 128
   uint32_t sourceL2Id;
   uint32_t destinationL2Id;
};

struct PC5SEstablishRsp{
129 130 131
   uint32_t slrbid_lcid28;
   uint32_t slrbid_lcid29;
   uint32_t slrbid_lcid30;
132
};
133

134

135
//PC5_DISCOVERY MESSAGE
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
136
typedef struct  {
137 138
   unsigned char payload[PC5_DISCOVERY_PAYLOAD_SIZE];
   uint32_t measuredPower;
139
}  __attribute__((__packed__)) PC5DiscoveryMessage ;
140

Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
141

142 143 144 145
struct sidelink_ctrl_element {
   unsigned short type;
   union {
      struct GroupCommunicationEstablishReq group_comm_establish_req;
146
      struct DirectCommunicationEstablishReq direct_comm_establish_req;
147 148 149 150
      Group_Communication_Status_t group_comm_release_rsp;
      //struct DirectCommunicationReleaseReq  direct_comm_release_req;
      SL_UE_STATE_t ue_state;
      int slrb_id;
151 152
      struct PC5SEstablishReq pc5s_establish_req;
      struct PC5SEstablishRsp pc5s_establish_rsp;
153
      PC5DiscoveryMessage pc5_discovery_message;
154 155 156
   } sidelinkPrimitive;
};

Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
157

158 159 160 161 162 163 164 165
//global variables
extern struct sockaddr_in clientaddr;
extern int slrb_id;
extern pthread_mutex_t slrb_mutex;

//the thread function
void *send_UE_status_notification(void *);

Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
166

167

168 169
//#include "COMMON/openair_defs.h"
#ifndef USER_MODE
170
//#include <rtai.h>
171 172 173 174 175 176 177 178 179
#endif

#include "SystemInformationBlockType1.h"
#include "SystemInformation.h"
#include "RRCConnectionReconfiguration.h"
#include "RRCConnectionReconfigurationComplete.h"
#include "RRCConnectionSetup.h"
#include "RRCConnectionSetupComplete.h"
#include "RRCConnectionRequest.h"
180
#include "RRCConnectionReestablishmentRequest.h"
181
#include "BCCH-DL-SCH-Message.h"
182
#include "SBCCH-SL-BCH-MessageType.h"
183
#include "BCCH-BCH-Message.h"
Cedric Roux's avatar
Cedric Roux committed
184
#if defined(Rel10) || defined(Rel14)
185 186
#include "MCCH-Message.h"
#include "MBSFNAreaConfiguration-r9.h"
187
#include "SCellToAddMod-r10.h"
188
#endif
189 190
#include "AS-Config.h"
#include "AS-Context.h"
191 192
#include "UE-EUTRA-Capability.h"
#include "MeasResults.h"
193
#include "SidelinkUEInformation-r12.h"
194

Cedric Roux's avatar
Cedric Roux committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
/* correct Rel(8|10)/Rel14 differences
 * the code is in favor of Rel14, those defines do the translation
 */
#if !defined(Rel14)
#  define CipheringAlgorithm_r12_t e_SecurityAlgorithmConfig__cipheringAlgorithm
#  define CipheringAlgorithm_r12_eea0 SecurityAlgorithmConfig__cipheringAlgorithm_eea0
#  define CipheringAlgorithm_r12_eea1 SecurityAlgorithmConfig__cipheringAlgorithm_eea1
#  define CipheringAlgorithm_r12_eea2 SecurityAlgorithmConfig__cipheringAlgorithm_eea2
#  define CipheringAlgorithm_r12_spare1 SecurityAlgorithmConfig__cipheringAlgorithm_spare1
#  define Alpha_r12_al0 UplinkPowerControlCommon__alpha_al0
#  define Alpha_r12_al04 UplinkPowerControlCommon__alpha_al04
#  define Alpha_r12_al05 UplinkPowerControlCommon__alpha_al05
#  define Alpha_r12_al06 UplinkPowerControlCommon__alpha_al06
#  define Alpha_r12_al07 UplinkPowerControlCommon__alpha_al07
#  define Alpha_r12_al08 UplinkPowerControlCommon__alpha_al08
#  define Alpha_r12_al09 UplinkPowerControlCommon__alpha_al09
#  define Alpha_r12_al1 UplinkPowerControlCommon__alpha_al1
#  define PreambleTransMax_n3 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n3
#  define PreambleTransMax_n4 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n4
#  define PreambleTransMax_n5 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n5
#  define PreambleTransMax_n6 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n6
#  define PreambleTransMax_n7 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n7
#  define PreambleTransMax_n8 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n8
#  define PreambleTransMax_n10 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n10
#  define PreambleTransMax_n20 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n20
#  define PreambleTransMax_n50 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n50
#  define PreambleTransMax_n100 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n100
#  define PreambleTransMax_n200 RACH_ConfigCommon__ra_SupervisionInfo__preambleTransMax_n200
#  define PeriodicBSR_Timer_r12_sf5 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf5
#  define PeriodicBSR_Timer_r12_sf10 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf10
#  define PeriodicBSR_Timer_r12_sf16 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf16
#  define PeriodicBSR_Timer_r12_sf20 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf20
#  define PeriodicBSR_Timer_r12_sf32 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf32
#  define PeriodicBSR_Timer_r12_sf40 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf40
#  define PeriodicBSR_Timer_r12_sf64 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf64
#  define PeriodicBSR_Timer_r12_sf80 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf80
#  define PeriodicBSR_Timer_r12_sf128 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf128
#  define PeriodicBSR_Timer_r12_sf160 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf160
#  define PeriodicBSR_Timer_r12_sf320 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf320
#  define PeriodicBSR_Timer_r12_sf640 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf640
#  define PeriodicBSR_Timer_r12_sf1280 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf1280
#  define PeriodicBSR_Timer_r12_sf2560 MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_sf2560
#  define PeriodicBSR_Timer_r12_infinity MAC_MainConfig__ul_SCH_Config__periodicBSR_Timer_infinity
#  define RetxBSR_Timer_r12_sf320 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf320
#  define RetxBSR_Timer_r12_sf640 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf640
#  define RetxBSR_Timer_r12_sf1280 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf1280
#  define RetxBSR_Timer_r12_sf2560 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf2560
#  define RetxBSR_Timer_r12_sf5120 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf5120
#  define RetxBSR_Timer_r12_sf10240 MAC_MainConfig__ul_SCH_Config__retxBSR_Timer_sf10240
#endif

246
// This corrects something generated by asn1c which is different between Rel8 and Rel10
Cedric Roux's avatar
Cedric Roux committed
247
#if !defined(Rel10) && !defined(Rel14)
248 249 250 251 252 253 254 255 256 257 258 259
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member SystemInformation_r8_IEs_sib_TypeAndInfo_Member
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib2 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib2
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib3 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib3
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib4 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib4
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib5 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib5
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib6 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib6
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib7 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib7
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib8 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib8
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib9 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib9
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib10 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib10
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib11 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib11
#endif
260 261 262 263 264 265 266


#define NB_SIG_CNX_CH 1
#define NB_CNX_CH MAX_MOBILES_PER_ENB
#define NB_SIG_CNX_UE 2 //MAX_MANAGED_RG_PER_MOBILE
#define NB_CNX_UE 2//MAX_MANAGED_RG_PER_MOBILE

267
/*
Cedric Roux's avatar
Cedric Roux committed
268
#if defined(Rel10) || defined(Rel14)
269 270
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib12_v920 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib12_v920
#define SystemInformation_r8_IEs__sib_TypeAndInfo__Member_PR_sib13_v920 SystemInformation_r8_IEs_sib_TypeAndInfo_Member_PR_sib13_v920
271
#endif
272
*/
273 274 275 276 277 278 279
//#include "L3_rrc_defs.h"
#ifndef NO_RRM
#include "L3_rrc_interface.h"
#include "rrc_rrm_msg.h"
#include "rrc_rrm_interface.h"
#endif

280 281 282 283
#if defined(ENABLE_ITTI)
# include "intertask_interface.h"
#endif

Cedric Roux's avatar
Cedric Roux committed
284 285 286 287 288 289 290 291
/* TODO: be sure this include is correct.
 * It solves a problem of compilation of the RRH GW,
 * issue #186.
 */
#if !defined(ENABLE_ITTI)
# include "as_message.h"
#endif

292 293 294 295
#if defined(ENABLE_USE_MME)
# include "commonDef.h"
#endif

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
//--------
typedef unsigned int uid_t;
#define UID_LINEAR_ALLOCATOR_BITMAP_SIZE (((NUMBER_OF_UE_MAX/8)/sizeof(unsigned int)) + 1)
typedef struct uid_linear_allocator_s {
  unsigned int   bitmap[UID_LINEAR_ALLOCATOR_BITMAP_SIZE];
} uid_allocator_t;

//--------



#define PROTOCOL_RRC_CTXT_UE_FMT           PROTOCOL_CTXT_FMT
#define PROTOCOL_RRC_CTXT_UE_ARGS(CTXT_Pp) PROTOCOL_CTXT_ARGS(CTXT_Pp)

#define PROTOCOL_RRC_CTXT_FMT           PROTOCOL_CTXT_FMT
#define PROTOCOL_RRC_CTXT_ARGS(CTXT_Pp) PROTOCOL_CTXT_ARGS(CTXT_Pp)
312
/** @defgroup _rrc RRC
313
 * @ingroup _oai2
314 315 316 317
 * @{
 */


318 319
#define UE_MODULE_INVALID ((module_id_t) ~0) // FIXME attention! depends on type uint8_t!!!
#define UE_INDEX_INVALID  ((module_id_t) ~0) // FIXME attention! depends on type uint8_t!!! used to be -1
winckel's avatar
winckel committed
320

321 322 323 324 325 326 327 328
typedef enum {
  RRC_OK=0,
  RRC_ConnSetup_failed,
  RRC_PHY_RESYNCH,
  RRC_Handover_failed,
  RRC_HO_STARTED
} RRC_status_t;

winckel's avatar
winckel committed
329
typedef enum UE_STATE_e {
winckel's avatar
winckel committed
330 331
  RRC_INACTIVE=0,
  RRC_IDLE,
332 333
  RRC_SI_RECEIVED,
  RRC_CONNECTED,
334 335
  RRC_RECONFIGURED,
  RRC_HO_EXECUTION
336 337
} UE_STATE_t;

winckel's avatar
winckel committed
338
typedef enum HO_STATE_e {
339 340 341 342 343 344 345
  HO_IDLE=0,
  HO_MEASURMENT,
  HO_PREPARE,
  HO_CMD, // initiated by the src eNB
  HO_COMPLETE // initiated by the target eNB
} HO_STATE_t;

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
typedef enum SL_TRIGGER_e {
  SL_RECEIVE_COMMUNICATION=0,
  SL_TRANSMIT_RELAY_ONE_TO_ONE,
  SL_TRANSMIT_RELAY_ONE_TO_MANY,
  SL_TRANSMIT_NON_RELAY_ONE_TO_ONE,
  SL_TRANSMIT_NON_RELAY_ONE_TO_MANY,
  SL_RECEIVE_DISCOVERY,
  SL_TRANSMIT_NON_PS_DISCOVERY,
  SL_TRANSMIT_PS_DISCOVERY,
  SL_RECEIVE_V2X,
  SL_TRANSMIT_V2X,
  SL_REQUEST_DISCOVERY_TRANSMISSION_GAPS,
  SL_REQUEST_DISCOVERY_RECEPTION_GAPS
} SL_TRIGGER_t;

361 362
//#define NUMBER_OF_UE_MAX MAX_MOBILES_PER_RG
#define RRM_FREE(p)       if ( (p) != NULL) { free(p) ; p=NULL ; }
363 364 365
#define RRM_MALLOC(t,n)   (t *) malloc16( sizeof(t) * n )
#define RRM_CALLOC(t,n)   (t *) malloc16( sizeof(t) * n)
#define RRM_CALLOC2(t,s)  (t *) malloc16( s )
366

367 368 369
#define MAX_MEAS_OBJ 6
#define MAX_MEAS_CONFIG 6
#define MAX_MEAS_ID 6
370 371

#define PAYLOAD_SIZE_MAX 1024
372
#define RRC_BUF_SIZE 255
373
#define UNDEF_SECURITY_MODE 0xff
374
#define NO_SECURITY_MODE 0x20
375 376 377 378

#define CBA_OFFSET        0xfff4
// #define NUM_MAX_CBA_GROUP 4 // in the platform_constants

379
/* TS 36.331: RRC-TransactionIdentifier ::= INTEGER (0..3) */
380 381 382
#if defined(USRP_REC_PLAY)
#define RRC_TRANSACTION_IDENTIFIER_NUMBER  1
#else
383
#define RRC_TRANSACTION_IDENTIFIER_NUMBER  3
384
#endif
385

386 387 388 389 390 391 392 393 394 395 396 397
typedef struct {
  unsigned short transport_block_size;                  /*!< \brief Minimum PDU size in bytes provided by RLC to MAC layer interface */
  unsigned short max_transport_blocks;                  /*!< \brief Maximum PDU size in bytes provided by RLC to MAC layer interface */
  unsigned long  Guaranteed_bit_rate;           /*!< \brief Guaranteed Bit Rate (average) to be offered by MAC layer scheduling*/
  unsigned long  Max_bit_rate;                  /*!< \brief Maximum Bit Rate that can be offered by MAC layer scheduling*/
  uint8_t  Delay_class;                  /*!< \brief Delay class offered by MAC layer scheduling*/
  uint8_t  Target_bler;                  /*!< \brief Target Average Transport Block Error rate*/
  uint8_t  Lchan_t;                      /*!< \brief Logical Channel Type (BCCH,CCCH,DCCH,DTCH_B,DTCH,MRBCH)*/
} __attribute__ ((__packed__))  LCHAN_DESC;

#define LCHAN_DESC_SIZE sizeof(LCHAN_DESC)

winckel's avatar
winckel committed
398
typedef struct UE_RRC_INFO_s {
399
  UE_STATE_t State;
400
  uint8_t SIB1systemInfoValueTag;
401 402
  uint32_t SIStatus;
  uint32_t SIcnt;
Cedric Roux's avatar
Cedric Roux committed
403
#if defined(Rel10) || defined(Rel14)
404
  uint8_t MCCHStatus[8]; // MAX_MBSFN_AREA
405
#endif
406
  uint8_t SIwindowsize; //!< Corresponds to the SIB1 si-WindowLength parameter. The unit is ms. Possible values are (final): 1,2,5,10,15,20,40
407
  uint8_t handoverTarget;
408
  HO_STATE_t ho_state;
409
  uint16_t SIperiod; //!< Corresponds to the SIB1 si-Periodicity parameter (multiplied by 10). Possible values are (final): 80,160,320,640,1280,2560,5120
410
  unsigned short UE_index;
411 412 413 414 415 416 417 418
  uint32_t T300_active;
  uint32_t T300_cnt;
  uint32_t T304_active;
  uint32_t T304_cnt;
  uint32_t T310_active;
  uint32_t T310_cnt;
  uint32_t N310_cnt;
  uint32_t N311_cnt;
419
  rnti_t   rnti;
winckel's avatar
winckel committed
420
} __attribute__ ((__packed__)) UE_RRC_INFO;
421

422
typedef struct UE_S_TMSI_s {
gauthier's avatar
gauthier committed
423 424 425
  boolean_t  presence;
  mme_code_t mme_code;
  m_tmsi_t   m_tmsi;
winckel's avatar
winckel committed
426
} __attribute__ ((__packed__)) UE_S_TMSI;
427

428
#if defined(ENABLE_ITTI)
winckel's avatar
winckel committed
429
typedef enum e_rab_satus_e {
430
  E_RAB_STATUS_NEW,
431 432
  E_RAB_STATUS_DONE, // from the eNB perspective
  E_RAB_STATUS_ESTABLISHED, // get the reconfigurationcomplete form UE
433
  E_RAB_STATUS_FAILED,
434
  E_RAB_STATUS_TORELEASE  // to release DRB between eNB and UE
winckel's avatar
winckel committed
435 436
} e_rab_status_t;

437
typedef struct e_rab_param_s {
438 439
  e_rab_t param;
  uint8_t status;
440
  uint8_t xid; // transaction_id
441 442
  s1ap_Cause_t cause;
  uint8_t cause_value;
winckel's avatar
winckel committed
443
} __attribute__ ((__packed__)) e_rab_param_t;
444 445
#endif

446 447


448
/* Intermediate structure for Handover management. Associated per-UE in eNB_RRC_INST */
winckel's avatar
winckel committed
449
typedef struct HANDOVER_INFO_s {
450 451 452 453 454 455
  uint8_t ho_prepare;
  uint8_t ho_complete;
  uint8_t modid_s; //module_idP of serving cell
  uint8_t modid_t; //module_idP of target cell
  uint8_t ueid_s; //UE index in serving cell
  uint8_t ueid_t; //UE index in target cell
456 457
  AS_Config_t as_config; /* these two parameters are taken from 36.331 section 10.2.2: HandoverPreparationInformation-r8-IEs */
  AS_Context_t as_context; /* They are mandatory for HO */
458 459
  uint8_t buf[RRC_BUF_SIZE];  /* ASN.1 encoded handoverCommandMessage */
  int size;   /* size of above message in bytes */
winckel's avatar
winckel committed
460
} HANDOVER_INFO;
461 462 463

#define RRC_HEADER_SIZE_MAX 64
#define RRC_BUFFER_SIZE_MAX 1024
464
typedef struct {
465
  char Payload[RRC_BUFFER_SIZE_MAX];
466
  char Header[RRC_HEADER_SIZE_MAX];
467
  char payload_size;
468
} RRC_BUFFER;
469 470
#define RRC_BUFFER_SIZE sizeof(RRC_BUFFER)

winckel's avatar
winckel committed
471
typedef struct RB_INFO_s {
472
  uint16_t Rb_id;  //=Lchan_id
473
  LCHAN_DESC Lchan_desc[2];
474
  //  MAC_MEAS_REQ_ENTRY *Meas_entry;
winckel's avatar
winckel committed
475
} RB_INFO;
476

winckel's avatar
winckel committed
477
typedef struct SRB_INFO_s {
478
  uint16_t Srb_id;  //=Lchan_id
479 480
  RRC_BUFFER Rx_buffer;
  RRC_BUFFER Tx_buffer;
481 482
  LCHAN_DESC Lchan_desc[2];
  unsigned int Trans_id;
483
  uint8_t Active;
winckel's avatar
winckel committed
484
} SRB_INFO;
485

winckel's avatar
winckel committed
486
typedef struct RB_INFO_TABLE_ENTRY_s {
487
  RB_INFO Rb_info;
488 489 490
  uint8_t Active;
  uint32_t Next_check_frame;
  uint8_t Status;
winckel's avatar
winckel committed
491
} RB_INFO_TABLE_ENTRY;
492

winckel's avatar
winckel committed
493
typedef struct SRB_INFO_TABLE_ENTRY_s {
494
  SRB_INFO Srb_info;
495 496
  uint8_t Active;
  uint8_t Status;
497
  uint32_t Next_check_frame;
498
} SRB_INFO_TABLE_ENTRY;
499

winckel's avatar
winckel committed
500
typedef struct MEAS_REPORT_LIST_s {
501
  MeasId_t measId;
502
  //CellsTriggeredList  cellsTriggeredList;//OPTIONAL
503
  uint32_t numberOfReportsSent;
504
} MEAS_REPORT_LIST;
505

winckel's avatar
winckel committed
506
typedef struct HANDOVER_INFO_UE_s {
507
  PhysCellId_t targetCellId;
508
  uint8_t measFlag;
winckel's avatar
winckel committed
509
} HANDOVER_INFO_UE;
510

511
typedef struct eNB_RRC_UE_s {
512
  uint8_t                            primaryCC_id;
Cedric Roux's avatar
Cedric Roux committed
513
#if defined(Rel10) || defined(Rel14)
514 515 516
  SCellToAddMod_r10_t                sCell_config[2];
#endif
  SRB_ToAddModList_t*                SRB_configList;
517
  SRB_ToAddModList_t*                SRB_configList2[RRC_TRANSACTION_IDENTIFIER_NUMBER];
518
  DRB_ToAddModList_t*                DRB_configList;
519
  DRB_ToAddModList_t*                DRB_configList2[RRC_TRANSACTION_IDENTIFIER_NUMBER];
520
  DRB_ToReleaseList_t*               DRB_Release_configList2[RRC_TRANSACTION_IDENTIFIER_NUMBER];
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
  uint8_t                            DRB_active[8];
  struct PhysicalConfigDedicated*    physicalConfigDedicated;
  struct SPS_Config*                 sps_Config;
  MeasObjectToAddMod_t*              MeasObj[MAX_MEAS_OBJ];
  struct ReportConfigToAddMod*       ReportConfig[MAX_MEAS_CONFIG];
  struct QuantityConfig*             QuantityConfig;
  struct MeasIdToAddMod*             MeasId[MAX_MEAS_ID];
  MAC_MainConfig_t*                  mac_MainConfig;
  MeasGapConfig_t*                   measGapConfig;
  SRB_INFO                           SI;
  SRB_INFO                           Srb0;
  SRB_INFO_TABLE_ENTRY               Srb1;
  SRB_INFO_TABLE_ENTRY               Srb2;
  MeasConfig_t*                      measConfig;
  HANDOVER_INFO*                     handover_info;

#if defined(ENABLE_SECURITY)
  /* KeNB as derived from KASME received from EPC */
  uint8_t kenb[32];
540 541 542
  int8_t  kenb_ncc;
  uint8_t nh[32];
  int8_t  nh_ncc;
543 544
#endif
  /* Used integrity/ciphering algorithms */
Cedric Roux's avatar
Cedric Roux committed
545
  CipheringAlgorithm_r12_t                          ciphering_algorithm;
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
  e_SecurityAlgorithmConfig__integrityProtAlgorithm integrity_algorithm;

  uint8_t                            Status;
  rnti_t                             rnti;
  uint64_t                           random_ue_identity;

#if defined(ENABLE_ITTI)
  /* Information from UE RRC ConnectionRequest */
  UE_S_TMSI                          Initialue_identity_s_TMSI;
  EstablishmentCause_t               establishment_cause;

  /* Information from UE RRC ConnectionReestablishmentRequest */
  ReestablishmentCause_t             reestablishment_cause;

  /* UE id for initial connection to S1AP */
  uint16_t                           ue_initial_id;

  /* Information from S1AP initial_context_setup_req */
  uint32_t                           eNB_ue_s1ap_id :24;

  security_capabilities_t            security_capabilities;

568 569
  /* Total number of e_rab already setup in the list */
  uint8_t                           setup_e_rabs;
570 571
  /* Number of e_rab to be setup in the list */
  uint8_t                            nb_of_e_rabs;
572 573 574 575
  /* Number of e_rab to be modified in the list */
  uint8_t                            nb_of_modify_e_rabs;
  uint8_t                            nb_of_failed_e_rabs;
  e_rab_param_t                      modify_e_rab[NB_RB_MAX];//[S1AP_MAX_E_RAB];
576
  /* list of e_rab to be setup by RRC layers */
577
  e_rab_param_t                      e_rab[NB_RB_MAX];//[S1AP_MAX_E_RAB];
578 579 580
  //release e_rabs
  uint8_t                            nb_release_of_e_rabs;
  e_rab_failed_t                     e_rabs_release_failed[S1AP_MAX_E_RAB];
581 582 583 584 585
  // LG: For GTPV1 TUNNELS
  uint32_t                           enb_gtp_teid[S1AP_MAX_E_RAB];
  transport_layer_addr_t             enb_gtp_addrs[S1AP_MAX_E_RAB];
  rb_id_t                            enb_gtp_ebi[S1AP_MAX_E_RAB];
#endif
586
  uint32_t                           ul_failure_timer;
587
  uint32_t                           ue_release_timer;
588
  uint32_t                           ue_release_timer_thres;
589 590 591 592 593 594
  uint32_t                           ue_release_timer_s1;
  uint32_t                           ue_release_timer_thres_s1;
  uint32_t                           ue_release_timer_rrc;
  uint32_t                           ue_release_timer_thres_rrc;
  uint32_t                           ue_reestablishment_timer;
  uint32_t                           ue_reestablishment_timer_thres;
595
  uint8_t                            e_rab_release_command_flag;
596 597 598
} eNB_RRC_UE_t;

typedef uid_t ue_uid_t;
599

600 601 602 603 604 605 606 607 608
typedef struct rrc_eNB_ue_context_s {
  /* Tree related data */
  RB_ENTRY(rrc_eNB_ue_context_s) entries;

  /* Uniquely identifies the UE between MME and eNB within the eNB.
   * This id is encoded on 24bits.
   */
  rnti_t         ue_id_rnti;

609
  // another key for protocol layers but should not be used as a key for RB tree
610 611 612 613 614
  ue_uid_t       local_uid;

  /* UE id for initial connection to S1AP */
  struct eNB_RRC_UE_s   ue_context;
} rrc_eNB_ue_context_t;
615

616
typedef struct {
617 618
  uint8_t                           *MIB;
  uint8_t                           sizeof_MIB;
619 620 621 622
  uint8_t                           *SIB1;
  uint8_t                           sizeof_SIB1;
  uint8_t                           *SIB23;
  uint8_t                           sizeof_SIB23;
623
#ifdef Rel14
624 625
  uint8_t                           *SIB1_BR;
  uint8_t                           sizeof_SIB1_BR;
626 627 628
  uint8_t                           *SIB23_BR;
  uint8_t                           sizeof_SIB23_BR;
#endif
629 630 631 632 633
  int                               physCellId;
  int                               Ncp;
  int                               p_eNB;
  uint32_t                          dl_CarrierFreq;
  uint32_t                          ul_CarrierFreq;
634
  uint32_t                          pbch_repetition;
635 636 637 638 639 640
  BCCH_BCH_Message_t                mib;
  BCCH_DL_SCH_Message_t             siblock1;
  BCCH_DL_SCH_Message_t             systemInformation;
  //  SystemInformation_t               systemInformation;
  SystemInformationBlockType1_t     *sib1;
  SystemInformationBlockType2_t     *sib2;
641
  SystemInformationBlockType3_t     *sib3;
642
#ifdef Rel14
643
  SystemInformationBlockType1_t     *sib1_BR;
644
  SystemInformationBlockType2_t     *sib2_BR;
645
  SystemInformationBlockType2_t     *sib3_BR;
646
#endif
Cedric Roux's avatar
Cedric Roux committed
647
#if defined(Rel10) || defined(Rel14)
648 649
  SystemInformationBlockType13_r9_t *sib13;
  uint8_t                           MBMS_flag;
650 651 652
  uint8_t                           num_mbsfn_sync_area;
  uint8_t                           **MCCH_MESSAGE; //  MAX_MBSFN_AREA
  uint8_t                           sizeof_MCCH_MESSAGE[8];// MAX_MBSFN_AREA
653
  MCCH_Message_t            mcch;
654
  MBSFNAreaConfiguration_r9_t       *mcch_message;
655
  SRB_INFO                          MCCH_MESS[8];// MAX_MBSFN_AREA
656
#endif
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
657 658 659 660 661
  //TTN - SIB 18,19,21 for D2D
  SystemInformationBlockType18_r12_t *sib18;
  SystemInformationBlockType19_r12_t *sib19;
  SystemInformationBlockType21_r14_t *sib21;
  // End - TTN
662 663
  SRB_INFO                          SI;
  SRB_INFO                          Srb0;
664 665
  uint8_t                           *paging[NUMBER_OF_UE_MAX];
  uint32_t                           sizeof_paging[NUMBER_OF_UE_MAX];
666
} rrc_eNB_carrier_data_t;
667 668

typedef struct eNB_RRC_INST_s {
669 670
  /// southbound midhaul configuration
  eth_params_t                    eth_params_s;
671
  rrc_eNB_carrier_data_t          carrier[MAX_NUM_CCs];
672 673
  uid_allocator_t                    uid_allocator; // for rrc_ue_head
  RB_HEAD(rrc_ue_tree_s, rrc_eNB_ue_context_s)     rrc_ue_head; // ue_context tree key search by rnti
674
  uint8_t                           HO_flag;
675
  uint8_t                            Nb_ue;
676 677 678
  hash_table_t                      *initial_id2_s1ap_ids; // key is    content is rrc_ue_s1ap_ids_t
  hash_table_t                      *s1ap_id2_s1ap_ids   ; // key is    content is rrc_ue_s1ap_ids_t

679 680 681 682 683 684
#ifdef LOCALIZATION
  /// localization type, 0: power based, 1: time based
  uint8_t loc_type;
  /// epoch timestamp in millisecond, RRC
  int32_t reference_timestamp_ms;
  /// aggregate physical states every n millisecond
685
  int32_t aggregation_period_ms;
686 687
  /// localization list for aggregated measurements from PHY
  struct list loc_list;
688
#endif
689

690
  //RRC configuration
691
#if defined(ENABLE_ITTI)
692
  RrcConfigurationReq configuration;
693
#endif
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
  // other PLMN parameters
  /// Mobile country code
  int mcc;
  /// Mobile network code
  int mnc;
  /// number of mnc digits
  int mnc_digit_length;

  // other RAN parameters
  int srb1_timer_poll_retransmit;
  int srb1_poll_pdu;
  int srb1_poll_byte;
  int srb1_max_retx_threshold;
  int srb1_timer_reordering;
  int srb1_timer_status_prohibit;
  int srs_enable[MAX_NUM_CCs];
710 711 712
} eNB_RRC_INST;

#define MAX_UE_CAPABILITY_SIZE 255
winckel's avatar
winckel committed
713
typedef struct OAI_UECapability_s {
714 715 716 717 718
  uint8_t sdu[MAX_UE_CAPABILITY_SIZE];
  uint8_t sdu_size;
  UE_EUTRA_Capability_t *UE_EUTRA_Capability;
} OAI_UECapability_t;

winckel's avatar
winckel committed
719
typedef struct UE_RRC_INST_s {
winckel's avatar
winckel committed
720 721
  Rrc_State_t     RrcState;
  Rrc_Sub_State_t RrcSubState;
722
# if defined(ENABLE_USE_MME)
winckel's avatar
winckel committed
723 724 725
  plmn_t          plmnID;
  Byte_t          rat;
  as_nas_info_t   initialNasMsg;
726
# endif
727
  OAI_UECapability_t *UECap;
728 729 730 731 732 733
  uint8_t *UECapability;
  uint8_t UECapability_size;
  UE_RRC_INFO Info[NB_SIG_CNX_UE];
  SRB_INFO Srb0[NB_SIG_CNX_UE];
  SRB_INFO_TABLE_ENTRY Srb1[NB_CNX_UE];
  SRB_INFO_TABLE_ENTRY Srb2[NB_CNX_UE];
734
  HANDOVER_INFO_UE HandoverInfoUe;
735 736 737 738 739 740
  uint8_t *SIB1[NB_CNX_UE];
  uint8_t sizeof_SIB1[NB_CNX_UE];
  uint8_t *SI[NB_CNX_UE];
  uint8_t sizeof_SI[NB_CNX_UE];
  uint8_t SIB1Status[NB_CNX_UE];
  uint8_t SIStatus[NB_CNX_UE];
741
  SystemInformationBlockType1_t *sib1[NB_CNX_UE];
742
  SystemInformation_t *si[NB_CNX_UE]; //!< Temporary storage for an SI message. Decoding happens in decode_SI().
743 744 745 746 747 748 749 750 751 752
  SystemInformationBlockType2_t *sib2[NB_CNX_UE];
  SystemInformationBlockType3_t *sib3[NB_CNX_UE];
  SystemInformationBlockType4_t *sib4[NB_CNX_UE];
  SystemInformationBlockType5_t *sib5[NB_CNX_UE];
  SystemInformationBlockType6_t *sib6[NB_CNX_UE];
  SystemInformationBlockType7_t *sib7[NB_CNX_UE];
  SystemInformationBlockType8_t *sib8[NB_CNX_UE];
  SystemInformationBlockType9_t *sib9[NB_CNX_UE];
  SystemInformationBlockType10_t *sib10[NB_CNX_UE];
  SystemInformationBlockType11_t *sib11[NB_CNX_UE];
753 754
  uint8_t                           *MIB;
#ifdef Rel14
755
  //SIB18
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
756
  SystemInformationBlockType18_r12_t *sib18[NB_CNX_UE];
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
757
  SystemInformationBlockType19_r12_t *sib19[NB_CNX_UE];
758

759
  SBCCH_SL_BCH_MessageType_t   mib_sl[NB_CNX_UE];
760 761
  /// Preconfiguration for Sidelink
  struct SL_Preconfiguration_r12 *SL_Preconfiguration[NB_CNX_UE];
762 763 764 765
  //source L2 Id
  uint32_t sourceL2Id;
  //group L2 Id
  uint32_t groupL2Id;
766
  //current destination
767
  uint32_t destinationL2Id;
768 769
  //List of destinations
   uint32_t destinationList[MAX_NUM_DEST];
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
770 771
  //sl_discovery..
  SRB_INFO SL_Discovery[NB_CNX_UE];
772
#endif
773

Cedric Roux's avatar
Cedric Roux committed
774
#if defined(Rel10) || defined(Rel14)
775
  uint8_t                           MBMS_flag;
776 777 778
  uint8_t *MCCH_MESSAGE[NB_CNX_UE];
  uint8_t sizeof_MCCH_MESSAGE[NB_CNX_UE];
  uint8_t MCCH_MESSAGEStatus[NB_CNX_UE];
779
  MBSFNAreaConfiguration_r9_t       *mcch_message[NB_CNX_UE];
780 781
  SystemInformationBlockType12_r9_t *sib12[NB_CNX_UE];
  SystemInformationBlockType13_r9_t *sib13[NB_CNX_UE];
782
#endif
783 784 785 786
#ifdef CBA
  uint8_t                         num_active_cba_groups;
  uint16_t                        cba_rnti[NUM_MAX_CBA_GROUP];
#endif
787
  uint8_t                         num_srb;
788 789 790
  struct SRB_ToAddMod             *SRB1_config[NB_CNX_UE];
  struct SRB_ToAddMod             *SRB2_config[NB_CNX_UE];
  struct DRB_ToAddMod             *DRB_config[NB_CNX_UE][8];
791
  rb_id_t                         *defaultDRB; // remember the ID of the default DRB
792 793 794 795
  MeasObjectToAddMod_t            *MeasObj[NB_CNX_UE][MAX_MEAS_OBJ];
  struct ReportConfigToAddMod     *ReportConfig[NB_CNX_UE][MAX_MEAS_CONFIG];
  struct QuantityConfig           *QuantityConfig[NB_CNX_UE];
  struct MeasIdToAddMod           *MeasId[NB_CNX_UE][MAX_MEAS_ID];
796 797
  MEAS_REPORT_LIST      *measReportList[NB_CNX_UE][MAX_MEAS_ID];
  uint32_t           measTimer[NB_CNX_UE][MAX_MEAS_ID][6]; // 6 neighboring cells
798
  RSRP_Range_t                    s_measure;
799
  struct MeasConfig__speedStatePars *speedStatePars;
800 801 802 803
  struct PhysicalConfigDedicated  *physicalConfigDedicated[NB_CNX_UE];
  struct SPS_Config               *sps_Config[NB_CNX_UE];
  MAC_MainConfig_t                *mac_MainConfig[NB_CNX_UE];
  MeasGapConfig_t                 *measGapConfig[NB_CNX_UE];
804
  double                          filter_coeff_rsrp; // [7] ???
805
  double                          filter_coeff_rsrq; // [7] ???
806 807 808 809
  float                           rsrp_db[7];
  float                           rsrq_db[7];
  float                           rsrp_db_filtered[7];
  float                           rsrq_db_filtered[7];
810 811 812
#if defined(ENABLE_SECURITY)
  /* KeNB as computed from parameters within USIM card */
  uint8_t kenb[32];
813 814
  uint8_t nh[32];
  int8_t  nh_ncc;
815 816 817
#endif

  /* Used integrity/ciphering algorithms */
Cedric Roux's avatar
Cedric Roux committed
818
  CipheringAlgorithm_r12_t                          ciphering_algorithm;
819
  e_SecurityAlgorithmConfig__integrityProtAlgorithm integrity_algorithm;
820 821 822 823 824

#ifdef Rel14
  /// Used for Sidelink Preconfiguration
  DRB_ToAddModList_t *DRB_configList;
#endif
winckel's avatar
winckel committed
825
} UE_RRC_INST;
826

827 828 829 830 831 832 833 834
typedef struct UE_PF_PO_s {
  boolean_t enable_flag;  /* flag indicate whether current object is used */
  uint16_t ue_index_value;  /* UE index value */
  uint8_t PF_min;  /* minimal value of Paging Frame (PF) */
  uint8_t PO;  /* Paging Occasion (PO) */
  uint32_t T;  /* DRX cycle */
} UE_PF_PO_t;

835
#include "proto.h"
winckel's avatar
winckel committed
836

837
#endif
838
/** @} */