Lionel Gauthier
36ecc8484d
git-svn-id: http://svn.eurecom.fr/openair4G/trunk@6326 818b1a75-f10b-46b9-bf7c-635c3b92a50f
126 lines
6.6 KiB
C
Executable File
126 lines
6.6 KiB
C
Executable File
/*******************************************************************************
|
|
OpenAirInterface
|
|
Copyright(c) 1999 - 2014 Eurecom
|
|
|
|
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.
|
|
|
|
|
|
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.
|
|
|
|
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/>.
|
|
|
|
Contact Information
|
|
OpenAirInterface Admin: openair_admin@eurecom.fr
|
|
OpenAirInterface Tech : openair_tech@eurecom.fr
|
|
OpenAirInterface Dev : openair4g-devel@eurecom.fr
|
|
|
|
Address : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
|
|
|
|
*******************************************************************************/
|
|
/*! \file rlc_am_init.h
|
|
* \brief This file defines the prototypes of the functions initializing a RLC AM protocol instance.
|
|
* \author GAUTHIER Lionel
|
|
* \date 2010-2011
|
|
* \version
|
|
* \note
|
|
* \bug
|
|
* \warning
|
|
*/
|
|
/** @defgroup _rlc_am_init_impl_ RLC AM Init Reference Implementation
|
|
* @ingroup _rlc_am_impl_
|
|
* @{
|
|
*/
|
|
#ifndef __RLC_AM_INIT_H__
|
|
# define __RLC_AM_INIT_H__
|
|
|
|
# include "UTIL/MEM/mem_block.h"
|
|
//-----------------------------------------------------------------------------
|
|
# ifdef RLC_AM_INIT_C
|
|
# define private_rlc_am_init(x) x
|
|
# define protected_rlc_am_init(x) x
|
|
# define public_rlc_am_init(x) x
|
|
# else
|
|
# ifdef RLC_AM_MODULE
|
|
# define private_rlc_am_init(x)
|
|
# define protected_rlc_am_init(x) extern x
|
|
# define public_rlc_am_init(x) extern x
|
|
# else
|
|
# define private_rlc_am_init(x)
|
|
# define protected_rlc_am_init(x)
|
|
# define public_rlc_am_init(x) extern x
|
|
# endif
|
|
# endif
|
|
//-----------------------------------------------------------------------------
|
|
#include "platform_types.h"
|
|
#include "platform_constants.h"
|
|
#include "PHY/defs.h"
|
|
|
|
|
|
/*! \struct rlc_am_info_t
|
|
* \brief Structure containing RLC AM configuration parameters.
|
|
*/
|
|
typedef volatile struct {
|
|
uint16_t max_retx_threshold; /*!< \brief Maximum number of retransmissions for one RLC AM PDU. */
|
|
uint16_t poll_pdu; /*!< \brief Generate a status each poll_pdu pdu sent. */
|
|
uint16_t poll_byte; /*!< \brief Generate a status each time poll_byte bytes have been sent. */
|
|
uint32_t t_poll_retransmit; /*!< \brief t-PollRetransmit timer initial value. */
|
|
uint32_t t_reordering; /*!< \brief t-Reordering timer initial value. */
|
|
uint32_t t_status_prohibit; /*!< \brief t-StatusProhibit timer initial value. */
|
|
} rlc_am_info_t;
|
|
|
|
//-----------------------------------------------------------------------------
|
|
/*! \fn void rlc_am_init (const protocol_ctxt_t* const ctxtP, rlc_am_entity_t * const rlc_pP)
|
|
* \brief Initialize the RLC AM protocol instance, reset variables, allocate buffers, lists, then, the next step in order have a running RLC AM instance is to configure and set debug informations for this RLC instance.
|
|
* \param[in] ctxtP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
*/
|
|
public_rlc_am_init( void rlc_am_init (const protocol_ctxt_t* const ctxtP, rlc_am_entity_t* rlc_pP);)
|
|
|
|
/*! \fn void rlc_am_cleanup(const protocol_ctxt_t* const ctxtP, rlc_am_entity_t *const rlc_pP)
|
|
* \brief Free all memory resources allocated and kept by this RLC AM instance.
|
|
* \param[in] ctxtP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
*/
|
|
public_rlc_am_init( void rlc_am_cleanup(const protocol_ctxt_t* const ctxtP, rlc_am_entity_t* rlc_pP);)
|
|
|
|
/*! \fn void rlc_am_configure(const protocol_ctxt_t* const ctxtP, rlc_am_entity_t * const rlc_pP, uint16_t max_retx_thresholdP, uint16_t poll_pduP, uint16_t poll_byteP, uint32_t t_poll_retransmitP, uint32_t t_reorderingP, uint32_t t_status_prohibitP)
|
|
* \brief Set RLC AM protocol parameters.
|
|
* \param[in] ctxtP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] max_retx_thresholdP Limit the number of retransmissions of an
|
|
AMD PDU.
|
|
* \param[in] poll_pduP Trigger a poll for every poll_pduP PDUs.
|
|
* \param[in] poll_byteP Trigger a poll for every pollByte bytes.
|
|
* \param[in] t_poll_retransmitP This timer is used by the transmitting side of an AM RLC entity in order to retransmit a poll, value in frames.
|
|
* \param[in] t_reorderingP This timer is used by the receiving side of an AM RLC entity in order to detect loss of RLC PDUs at lower layer, value in frames.
|
|
* \param[in] t_status_prohibitP This timer is used by the receiving side of an AM RLC entity in order to prohibit transmission of a STATUS PDU, value in frames.
|
|
*/
|
|
public_rlc_am_init( void rlc_am_configure(const protocol_ctxt_t* const ctxtP,
|
|
rlc_am_entity_t * const rlc_pP,
|
|
const uint16_t max_retx_thresholdP,
|
|
const uint16_t poll_pduP,
|
|
const uint16_t poll_byteP,
|
|
const uint32_t t_poll_retransmitP,
|
|
const uint32_t t_reorderingP,
|
|
const uint32_t t_status_prohibitP);)
|
|
|
|
/*! \fn void rlc_am_set_debug_infos(const protocol_ctxt_t* const ctxtP, rlc_am_entity_t * const rlc_pP, const srb_flag_t srb_flagP, const rb_id_t rb_idP)
|
|
* \brief Set informations that will be displayed in traces, helping the debug process.
|
|
* \param[in] ctxtP Running context.
|
|
* \param[in] rlc_pP RLC AM protocol instance pointer.
|
|
* \param[in] srb_flagP Flag to indicate signalling radio bearer (1) or data radio bearer (0).
|
|
* \param[in] rb_idP Radio bearer identifier.
|
|
*/
|
|
public_rlc_am_init( void rlc_am_set_debug_infos(const protocol_ctxt_t* const ctxtP, rlc_am_entity_t * const rlc_pP, const srb_flag_t srb_flagP, const rb_id_t rb_idP);)
|
|
/** @} */
|
|
#endif
|