Cedric Roux
18cb68ecc2
This code has not been tested with a COTS UE. We need SRB1/2 (so we need SA) to test. The activation of security and integrity for SRB1 will need more code (new functions) because it happens after some time, not at creation time of the PDCP entity and there is no way to do this with current code.
125 lines
4.3 KiB
C
125 lines
4.3 KiB
C
/*
|
|
* 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.1 (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
|
|
*/
|
|
|
|
#ifndef _NR_PDCP_ENTITY_H_
|
|
#define _NR_PDCP_ENTITY_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "nr_pdcp_sdu.h"
|
|
|
|
typedef enum {
|
|
NR_PDCP_DRB_AM,
|
|
NR_PDCP_DRB_UM,
|
|
NR_PDCP_SRB
|
|
} nr_pdcp_entity_type_t;
|
|
|
|
typedef struct nr_pdcp_entity_t {
|
|
nr_pdcp_entity_type_t type;
|
|
|
|
/* functions provided by the PDCP module */
|
|
void (*recv_pdu)(struct nr_pdcp_entity_t *entity, char *buffer, int size);
|
|
void (*recv_sdu)(struct nr_pdcp_entity_t *entity, char *buffer, int size,
|
|
int sdu_id);
|
|
void (*delete)(struct nr_pdcp_entity_t *entity);
|
|
void (*set_integrity_key)(struct nr_pdcp_entity_t *entity, char *key);
|
|
void (*set_time)(struct nr_pdcp_entity_t *entity, uint64_t now);
|
|
|
|
/* callbacks provided to the PDCP module */
|
|
void (*deliver_sdu)(void *deliver_sdu_data, struct nr_pdcp_entity_t *entity,
|
|
char *buf, int size);
|
|
void *deliver_sdu_data;
|
|
void (*deliver_pdu)(void *deliver_pdu_data, struct nr_pdcp_entity_t *entity,
|
|
char *buf, int size, int sdu_id);
|
|
void *deliver_pdu_data;
|
|
|
|
/* configuration variables */
|
|
int rb_id;
|
|
|
|
int sn_size; /* SN size, in bits */
|
|
int t_reordering; /* unit: ms */
|
|
int discard_timer; /* unit: ms */
|
|
|
|
int sn_max; /* (2^SN_size) - 1 */
|
|
int window_size; /* 2^(SN_size - 1) */
|
|
|
|
/* state variables */
|
|
uint32_t tx_next;
|
|
uint32_t rx_next;
|
|
uint32_t rx_deliv;
|
|
uint32_t rx_reord;
|
|
|
|
/* set to the latest know time by the user of the module. Unit: ms */
|
|
uint64_t t_current;
|
|
|
|
/* timers (stores the ms of activation, 0 means not active) */
|
|
int t_reordering_start;
|
|
|
|
/* security */
|
|
int has_ciphering;
|
|
int has_integrity;
|
|
int ciphering_algorithm;
|
|
int integrity_algorithm;
|
|
unsigned char ciphering_key[16];
|
|
unsigned char integrity_key[16];
|
|
void *security_context;
|
|
void (*cipher)(void *security_context,
|
|
unsigned char *buffer, int length,
|
|
int bearer, int count, int direction);
|
|
void (*free_security)(void *security_context);
|
|
void *integrity_context;
|
|
void (*integrity)(void *integrity_context, unsigned char *out,
|
|
unsigned char *buffer, int length,
|
|
int bearer, int count, int direction);
|
|
void (*free_integrity)(void *integrity_context);
|
|
/* security/integrity algorithms need to know uplink/downlink information
|
|
* which is reverse for gnb and ue, so we need to know if this
|
|
* pdcp entity is for a gnb or an ue
|
|
*/
|
|
int is_gnb;
|
|
|
|
/* rx management */
|
|
nr_pdcp_sdu_t *rx_list;
|
|
int rx_size;
|
|
int rx_maxsize;
|
|
} nr_pdcp_entity_t;
|
|
|
|
nr_pdcp_entity_t *new_nr_pdcp_entity(
|
|
nr_pdcp_entity_type_t type,
|
|
int is_gnb, int rb_id,
|
|
void (*deliver_sdu)(void *deliver_sdu_data, struct nr_pdcp_entity_t *entity,
|
|
char *buf, int size),
|
|
void *deliver_sdu_data,
|
|
void (*deliver_pdu)(void *deliver_pdu_data, struct nr_pdcp_entity_t *entity,
|
|
char *buf, int size, int sdu_id),
|
|
void *deliver_pdu_data,
|
|
int sn_size,
|
|
int t_reordering,
|
|
int discard_timer,
|
|
int ciphering_algorithm,
|
|
int integrity_algorithm,
|
|
unsigned char *ciphering_key,
|
|
unsigned char *integrity_key);
|
|
|
|
void nr_DRB_preconfiguration(uint16_t crnti);
|
|
|
|
#endif /* _NR_PDCP_ENTITY_H_ */
|