Robert Schmidt
eeaa5a99d0
Previously, the various rlc_*_ind() functions had a parameter to enable the MAC to specify the max TB size that a subsequent call to the corresponding rlc_*_req() (!) function would return. This patch removes this parameter from the rlc_*_ind() functions and makes the parameter working that is already in the rlc_*_req() functions.
301 lines
16 KiB
C
301 lines
16 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
|
|
*/
|
|
|
|
/*! \file rlc_am.h
|
|
* \brief This file, and only this file must be included by code that interact with RLC AM layer.
|
|
* \author GAUTHIER Lionel
|
|
* \date 2010-2011
|
|
* \version
|
|
* \note
|
|
* \bug
|
|
* \warning
|
|
*/
|
|
/** @defgroup _rlc_am_impl_ RLC AM Layer Reference Implementation
|
|
* @ingroup _rlc_impl_
|
|
* @{
|
|
*/
|
|
|
|
# ifndef __RLC_AM_H__
|
|
# define __RLC_AM_H__
|
|
# include "platform_types.h"
|
|
# include "rlc_def.h"
|
|
# include "rlc_def_lte.h"
|
|
# include "rlc_am_constants.h"
|
|
# include "rlc_am_structs.h"
|
|
# include "rlc_am_entity.h"
|
|
# include "rlc_am_windows.h"
|
|
# include "mem_block.h"
|
|
# include "rlc_am_in_sdu.h"
|
|
# include "rlc_am_segment.h"
|
|
# include "rlc_am_segments_holes.h"
|
|
# include "rlc_am_timer_poll_retransmit.h"
|
|
# include "rlc_am_timer_reordering.h"
|
|
# include "rlc_am_timer_status_prohibit.h"
|
|
# include "rlc_am_retransmit.h"
|
|
# include "rlc_am_receiver.h"
|
|
# include "rlc_am_status_report.h"
|
|
# include "rlc_am_rx_list.h"
|
|
# include "rlc_am_reassembly.h"
|
|
# include "rlc_am_init.h"
|
|
# include "LTE_RLC-Config.h"
|
|
# include "assertions.h"
|
|
//# include "rlc_am_test.h"
|
|
|
|
|
|
#define PROTOCOL_RLC_AM_CTXT_FMT PROTOCOL_CTXT_FMT"[%s %02ld]"
|
|
#define PROTOCOL_RLC_AM_CTXT_ARGS(CTXT_Pp, rLC_Pp) PROTOCOL_CTXT_ARGS(CTXT_Pp),\
|
|
(rLC_Pp->is_data_plane) ? "DRB AM" : "SRB AM",\
|
|
rLC_Pp->rb_id
|
|
|
|
#define PROTOCOL_RLC_AM_MSC_FMT "[RNTI %" PRIx16 " %s %02ld]"
|
|
#define PROTOCOL_RLC_AM_MSC_ARGS(CTXT_Pp, rLC_Pp) \
|
|
CTXT_Pp->rnti,\
|
|
(rLC_Pp->is_data_plane) ? "DRB AM" : "SRB AM",\
|
|
rLC_Pp->rb_id
|
|
|
|
|
|
#if defined(TRACE_RLC_MUTEX)
|
|
#define RLC_AM_MUTEX_LOCK(mUTEX, cTXT, rLC) \
|
|
do {\
|
|
int pmtl_rc = pthread_mutex_trylock(mUTEX);\
|
|
if (pmtl_rc != 0){\
|
|
if (pmtl_rc == EBUSY) {\
|
|
MSC_LOG_EVENT((cTXT->enb_flag == ENB_FLAG_YES) ? MSC_RLC_ENB:MSC_RLC_UE,\
|
|
"0 " PROTOCOL_RLC_AM_MSC_FMT " Warning try lock %s busy",\
|
|
PROTOCOL_RLC_AM_MSC_ARGS(cTXT,rLC),\
|
|
#mUTEX);\
|
|
pthread_mutex_lock(mUTEX);\
|
|
} else {\
|
|
MSC_LOG_EVENT((cTXT->enb_flag == ENB_FLAG_YES) ? MSC_RLC_ENB:MSC_RLC_UE,\
|
|
"0 " PROTOCOL_RLC_AM_MSC_FMT " Error try lock %s %d",\
|
|
PROTOCOL_RLC_AM_MSC_ARGS(cTXT,rLC),\
|
|
#mUTEX, pmtl_rc);\
|
|
}\
|
|
}\
|
|
} while (0);
|
|
#else
|
|
#define RLC_AM_MUTEX_LOCK(mUTEX, cTXT, rLC) pthread_mutex_lock(mUTEX)
|
|
#endif
|
|
|
|
#define RLC_AM_MUTEX_UNLOCK(mUTEX) pthread_mutex_unlock(mUTEX)
|
|
|
|
/*! \fn void rlc_am_release (const protocol_ctxt_t* const ctxtP, rlc_am_entity_t * const rlc_pP)
|
|
* \brief Empty function, TO DO.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
*/
|
|
void rlc_am_release (
|
|
const protocol_ctxt_t* const ctxtP,
|
|
rlc_am_entity_t * const rlc_pP);
|
|
|
|
/** @addtogroup _rlc_am_init_impl_
|
|
* @{
|
|
*/
|
|
|
|
/*! \fn void config_req_rlc_am (const protocol_ctxt_t* const ctxtP, const srb_flag_t srb_flagP, rlc_am_info_t * config_amP, rb_id_t rb_idP, logical_chan_id_t chan_idP)
|
|
* \brief Configure the UL and DL parameters of the RLC AM
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] srb_flagP Flag to indicate signalling radio bearer (1) or data radio bearer (0).
|
|
* \param[in] config_amP Configuration parameters for RLC AM instance.
|
|
* \param[in] rb_idP Radio bearer identifier.
|
|
* \param[in] chan_idP Transport channel identifier.
|
|
*/
|
|
void
|
|
config_req_rlc_am (
|
|
const protocol_ctxt_t* const ctxt_pP,
|
|
const srb_flag_t srb_flagP,
|
|
const rlc_am_info_t * config_am_pP,
|
|
const rb_id_t rb_idP,
|
|
const logical_chan_id_t chan_idP
|
|
);
|
|
|
|
/*! \fn void config_req_rlc_am_asn1 (const protocol_ctxt_t* const ctxtP, const srb_flag_t srb_flagP, struct RLC_Config__am * config_amP, rb_id_t rb_idP, logical_chan_id_t chan_idP)
|
|
* \brief Configure the UL and DL parameters of the RLC AM with the asn1c autogenerated pameters structs
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] srb_flagP Flag to indicate signalling radio bearer (1) or data radio bearer (0).
|
|
* \param[in] config_amP Configuration parameters for RLC AM instance.
|
|
* \param[in] rb_idP Radio bearer identifier.
|
|
* \param[in] chan_idP Transport channel identifier.
|
|
*/
|
|
void config_req_rlc_am_asn1 (
|
|
const protocol_ctxt_t* const ctxtP,
|
|
const srb_flag_t srb_flagP,
|
|
const struct LTE_RLC_Config__am * const config_amP,
|
|
const rb_id_t rb_idP,
|
|
const logical_chan_id_t chan_idP);
|
|
|
|
/** @} */
|
|
|
|
/*! \fn void rlc_am_stat_req (
|
|
const protocol_ctxt_t* const ctxtP,
|
|
rlc_am_entity_t * const rlc_pP,
|
|
unsigned int* stat_tx_pdcp_sdu,
|
|
unsigned int* stat_tx_pdcp_bytes,
|
|
unsigned int* stat_tx_pdcp_sdu_discarded,
|
|
unsigned int* stat_tx_pdcp_bytes_discarded,
|
|
unsigned int* stat_tx_data_pdu,
|
|
unsigned int* stat_tx_data_bytes,
|
|
unsigned int* stat_tx_retransmit_pdu_by_status,
|
|
unsigned int* stat_tx_retransmit_bytes_by_status,
|
|
unsigned int* stat_tx_retransmit_pdu,
|
|
unsigned int* stat_tx_retransmit_bytes,
|
|
unsigned int* stat_tx_control_pdu,
|
|
unsigned int* stat_tx_control_bytes,
|
|
unsigned int* stat_rx_pdcp_sdu,
|
|
unsigned int* stat_rx_pdcp_bytes,
|
|
unsigned int* stat_rx_data_pdus_duplicate,
|
|
unsigned int* stat_rx_data_bytes_duplicate,
|
|
unsigned int* stat_rx_data_pdu,
|
|
unsigned int* stat_rx_data_bytes,
|
|
unsigned int* stat_rx_data_pdu_dropped,
|
|
unsigned int* stat_rx_data_bytes_dropped,
|
|
unsigned int* stat_rx_data_pdu_out_of_window,
|
|
unsigned int* stat_rx_data_bytes_out_of_window,
|
|
unsigned int* stat_rx_control_pdu,
|
|
unsigned int* stat_rx_control_bytes,
|
|
unsigned int* stat_timer_reordering_timed_out,
|
|
unsigned int* stat_timer_poll_retransmit_timed_out,
|
|
unsigned int* stat_timer_status_prohibit_timed_out)
|
|
* \brief Request TX and RX statistics of a RLC AM protocol instance.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[out] stat_tx_pdcp_sdu Number of SDUs coming from upper layers.
|
|
* \param[out] stat_tx_pdcp_bytes Number of bytes coming from upper layers.
|
|
* \param[out] stat_tx_pdcp_sdu_discarded Number of discarded SDUs coming from upper layers.
|
|
* \param[out] stat_tx_pdcp_bytes_discarded Number of discarded bytes coming from upper layers.
|
|
* \param[out] stat_tx_data_pdu Number of transmitted data PDUs to lower layers.
|
|
* \param[out] stat_tx_data_bytes Number of transmitted data bytes to lower layers.
|
|
* \param[out] stat_tx_retransmit_pdu_by_status Number of re-transmitted data PDUs due to status reception.
|
|
* \param[out] stat_tx_retransmit_bytes_by_status Number of re-transmitted data bytes due to status reception.
|
|
* \param[out] stat_tx_retransmit_pdu Number of re-transmitted data PDUs to lower layers.
|
|
* \param[out] stat_tx_retransmit_bytes Number of re-transmitted data bytes to lower layers.
|
|
* \param[out] stat_tx_control_pdu Number of transmitted control PDUs to lower layers.
|
|
* \param[out] stat_tx_control_bytes Number of transmitted control bytes to lower layers.
|
|
* \param[out] stat_rx_pdcp_sdu Number of SDUs delivered to upper layers.
|
|
* \param[out] stat_rx_pdcp_bytes Number of bytes delivered to upper layers.
|
|
* \param[out] stat_rx_data_pdus_duplicate Number of duplicate PDUs received.
|
|
* \param[out] stat_rx_data_bytes_duplicate Number of duplicate bytes received.
|
|
* \param[out] stat_rx_data_pdu Number of received PDUs from lower layers.
|
|
* \param[out] stat_rx_data_bytes Number of received bytes from lower layers.
|
|
* \param[out] stat_rx_data_pdu_dropped Number of received PDUs from lower layers, then dropped.
|
|
* \param[out] stat_rx_data_bytes_dropped Number of received bytes from lower layers, then dropped.
|
|
* \param[out] stat_rx_data_pdu_out_of_window Number of data PDUs received out of the receive window.
|
|
* \param[out] stat_rx_data_bytes_out_of_window Number of data bytes received out of the receive window.
|
|
* \param[out] stat_rx_control_pdu Number of control PDUs received.
|
|
* \param[out] stat_rx_control_bytes Number of control bytes received.
|
|
* \param[out] stat_timer_reordering_timed_out Number of times the timer "reordering" has timed-out.
|
|
* \param[out] stat_timer_poll_retransmit_timed_out Number of times the timer "poll_retransmit" has timed-out.
|
|
* \param[out] stat_timer_status_prohibit_timed_out Number of times the timer "status_prohibit" has timed-out.
|
|
*/
|
|
void rlc_am_stat_req (
|
|
const protocol_ctxt_t* const ctxtP,
|
|
rlc_am_entity_t * const rlc_pP,
|
|
unsigned int* stat_tx_pdcp_sdu,
|
|
unsigned int* stat_tx_pdcp_bytes,
|
|
unsigned int* stat_tx_pdcp_sdu_discarded,
|
|
unsigned int* stat_tx_pdcp_bytes_discarded,
|
|
unsigned int* stat_tx_data_pdu,
|
|
unsigned int* stat_tx_data_bytes,
|
|
unsigned int* stat_tx_retransmit_pdu_by_status,
|
|
unsigned int* stat_tx_retransmit_bytes_by_status,
|
|
unsigned int* stat_tx_retransmit_pdu,
|
|
unsigned int* stat_tx_retransmit_bytes,
|
|
unsigned int* stat_tx_control_pdu,
|
|
unsigned int* stat_tx_control_bytes,
|
|
unsigned int* stat_rx_pdcp_sdu,
|
|
unsigned int* stat_rx_pdcp_bytes,
|
|
unsigned int* stat_rx_data_pdus_duplicate,
|
|
unsigned int* stat_rx_data_bytes_duplicate,
|
|
unsigned int* stat_rx_data_pdu,
|
|
unsigned int* stat_rx_data_bytes,
|
|
unsigned int* stat_rx_data_pdu_dropped,
|
|
unsigned int* stat_rx_data_bytes_dropped,
|
|
unsigned int* stat_rx_data_pdu_out_of_window,
|
|
unsigned int* stat_rx_data_bytes_out_of_window,
|
|
unsigned int* stat_rx_control_pdu,
|
|
unsigned int* stat_rx_control_bytes,
|
|
unsigned int* stat_timer_reordering_timed_out,
|
|
unsigned int* stat_timer_poll_retransmit_timed_out,
|
|
unsigned int* stat_timer_status_prohibit_timed_out);
|
|
|
|
/*! \fn void rlc_am_get_pdus (const protocol_ctxt_t* const ctxtP, void * const rlc_pP)
|
|
* \brief Request the segmentation of SDUs based on status previously sent by MAC.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
*/
|
|
void
|
|
rlc_am_get_pdus (
|
|
const protocol_ctxt_t* const ctxt_pP,
|
|
rlc_am_entity_t * const rlc_pP
|
|
);
|
|
|
|
/*! \fn void rlc_am_rx (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, struct mac_data_ind data_indication)
|
|
* \brief Process the received PDUs from lower layer.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] data_indication PDUs from MAC.
|
|
*/
|
|
void rlc_am_rx (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, struct mac_data_ind);
|
|
|
|
/*! \fn struct mac_status_resp rlc_am_mac_status_indication (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, struct mac_status_ind tx_statusP,const eNB_flag_t enb_flagP)
|
|
* \brief Request the maximum number of bytes that can be served by RLC instance to MAC and fix the amount of bytes requested by MAC for next RLC transmission.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] tx_statusP Transmission status given by MAC on previous MAC transmission of the PDU.
|
|
* \param[in] enb_flagP eNB or UE flag indication.
|
|
* \return The maximum number of bytes that can be served by RLC instance to MAC.
|
|
*/
|
|
struct mac_status_resp rlc_am_mac_status_indication (const protocol_ctxt_t* const ctxtP, void * const rlc_pP, struct mac_status_ind tx_statusP,const eNB_flag_t enb_flagP);
|
|
|
|
/*! \fn struct mac_data_req rlc_am_mac_data_request (const protocol_ctxt_t* const ctxtP,void * const rlc_pP,const eNB_flag_t enb_flagP)
|
|
* \brief Gives PDUs to lower layer MAC.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] enb_flagP eNB or UE flag
|
|
* \return A PDU of the previously requested number of bytes, and the updated maximum number of bytes that can be served by RLC instance to MAC for next RLC transmission.
|
|
*/
|
|
struct mac_data_req rlc_am_mac_data_request (const protocol_ctxt_t* const ctxtP,void * const rlc_pP,const eNB_flag_t enb_flagP);
|
|
|
|
/*! \fn void rlc_am_mac_data_indication (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, struct mac_data_ind data_indP)
|
|
* \brief Receive PDUs from lower layer MAC.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] data_indP PDUs from MAC.
|
|
*/
|
|
void rlc_am_mac_data_indication (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, struct mac_data_ind data_indP);
|
|
|
|
/*! \fn uint32_t rlc_am_get_buffer_occupancy_in_bytes (const protocol_ctxt_t* const ctxt_pP, rlc_am_entity_t * const rlc_pP)
|
|
* \brief Get Tx Buffer Occupancy.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
*/
|
|
uint32_t rlc_am_get_buffer_occupancy_in_bytes (const protocol_ctxt_t* const ctxt_pP, rlc_am_entity_t * const rlc_pP);
|
|
|
|
/*! \fn void rlc_am_data_req (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, mem_block_t *sduP)
|
|
* \brief Interface with higher layers, buffer higher layer SDUS for transmission.
|
|
* \param[in] ctxt_pP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] sduP SDU. (A struct rlc_am_data_req is mapped on sduP->data.)
|
|
*/
|
|
void rlc_am_data_req (const protocol_ctxt_t* const ctxtP,void * const rlc_pP, mem_block_t *sduP);
|
|
/** @} */
|
|
# endif
|