Skip to content

O
OpenXG-RAN
Commit d25a7850 authored by Florian Kaltenberger's avatar Florian Kaltenberger
Browse files
Options

added doxygen comments

parent 73f92fd9
Hide whitespace changes
Inline Side-by-side
Showing with 93 additions and 69 deletions
cmake_targets/CMakeLists.txt
View file @ d25a7850
...@@ -232,7 +232,7 @@ if (${RTAI}) ...@@ -232,7 +232,7 @@ if (${RTAI})
set(RTAI_SOURCE sched_dlsch.c sched_rx_pdsch.c rt_wrapper.c vcd_signal_dumper.c log.c) set(RTAI_SOURCE sched_dlsch.c sched_rx_pdsch.c rt_wrapper.c vcd_signal_dumper.c log.c)
endif (${RTAI}) endif (${RTAI})
add_boolean_option(FAPI False "Use FAPI scheduler") add_boolean_option(FAPI True "Use FAPI scheduler")
############################# #############################
# ASN.1 grammar C code generation & dependancies # ASN.1 grammar C code generation & dependancies
......
openair2/LAYER2/MAC/ff-mac-callback.h
View file @ d25a7850
#ifndef FF_MAC_CALLBACK_H #ifndef FF_MAC_CALLBACK_H
#define FF_MAC_CALLBACK_H #define FF_MAC_CALLBACK_H
#if defined (__cplusplus) /*!
extern "C" { * @ingroup _fapi
#endif */
/* these are the callback function types from the scheduler to openair */
#if defined (__cplusplus)
/* sched */ extern "C" {
typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params); #endif
typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
/* these are the callback function types from the scheduler to openair */
/* csched */
typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *params); /* sched */
typedef void (CschedUeConfigCnf_callback_t)(void *callback_data, const struct CschedUeConfigCnfParameters *params); typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params);
typedef void (CschedLcConfigCnf_callback_t)(void *callback_data, const struct CschedLcConfigCnfParameters *params); typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params); /* csched */
typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params); typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *params);
typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params); typedef void (CschedUeConfigCnf_callback_t)(void *callback_data, const struct CschedUeConfigCnfParameters *params);
typedef void (CschedLcConfigCnf_callback_t)(void *callback_data, const struct CschedLcConfigCnfParameters *params);
#if defined (__cplusplus) typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
} typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params);
#endif typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params);
typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params);
#endif /* FF_MAC_CALLBACK_H */
#if defined (__cplusplus)
}
#endif
#endif /* FF_MAC_CALLBACK_H */
openair2/LAYER2/MAC/ff-mac-common.h
View file @ d25a7850
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
......
openair2/LAYER2/MAC/ff-mac-csched-sap.h
View file @ d25a7850
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
#ifndef FF_MAC_CSCHED_SAP_H #ifndef FF_MAC_CSCHED_SAP_H
......
openair2/LAYER2/MAC/ff-mac-init.h
View file @ d25a7850
#ifndef FF_MAC_INIT_H #ifndef FF_MAC_INIT_H
#define FF_MAC_INIT_H #define FF_MAC_INIT_H
/*!
* @ingroup _fapi
*/
#if defined (__cplusplus) #if defined (__cplusplus)
extern "C" { extern "C" {
#endif #endif
......
openair2/LAYER2/MAC/ff-mac-sched-sap.h
View file @ d25a7850
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
* \date March 2015 * \date March 2015
* \version 1.0 * \version 1.0
* \email: florian.kaltenberger@eurecom.fr * \email: florian.kaltenberger@eurecom.fr
* @ingroup _mac * @ingroup _fapi
*/ */
#ifndef FF_MAC_SCHED_SAP_H #ifndef FF_MAC_SCHED_SAP_H
......
openair2/LAYER2/MAC/ff-mac.h
View file @ d25a7850
#ifndef FF_MAC_H #ifndef FF_MAC_H
#define FF_MAC_H #define FF_MAC_H
/* this file contains OAI related FAPI definitions */ /** @defgroup _fapi FAPI
* @ingroup _mac
/* this is the public view of the FAPI's OAI interface */ * @{
typedef struct { */
void *sched; /* this is the pointer returned by SchedInit */
/* to be used when calling FAPI functions */
} fapi_interface_t; /* this file contains OAI related FAPI definitions */
/* this function initializes OAI's FAPI interfacing /* this is the public view of the FAPI's OAI interface */
* it returns the opaque pointer given by SchedInit typedef struct {
*/ void *sched; /* this is the pointer returned by SchedInit */
fapi_interface_t *init_fapi(void); /* to be used when calling FAPI functions */
} fapi_interface_t;
/* the following functions are called by OAI
* they wait for the corresponding callback /* this function initializes OAI's FAPI interfacing
* to be called by the FAPI scheduler * it returns the opaque pointer given by SchedInit
*/ */
fapi_interface_t *init_fapi(void);
#include "ff-mac-sched-sap.h"
#include "ff-mac-csched-sap.h" /* the following functions are called by OAI
* they wait for the corresponding callback
/* from SCHED */ * to be called by the FAPI scheduler
void SchedDlConfigInd(fapi_interface_t *, struct SchedDlConfigIndParameters* params); */
void SchedUlConfigInd(fapi_interface_t *, struct SchedUlConfigIndParameters* params);
#include "ff-mac-sched-sap.h"
/* from CSCHED */ #include "ff-mac-csched-sap.h"
void CschedCellConfigCnf(fapi_interface_t *, struct CschedCellConfigCnfParameters *params);
void CschedUeConfigCnf(fapi_interface_t *, struct CschedUeConfigCnfParameters *params); /* from SCHED */
void CschedLcConfigCnf(fapi_interface_t *, struct CschedLcConfigCnfParameters *params); void SchedDlConfigInd(fapi_interface_t *, struct SchedDlConfigIndParameters* params);
void CschedLcReleaseCnf(fapi_interface_t *, struct CschedLcReleaseCnfParameters *params); void SchedUlConfigInd(fapi_interface_t *, struct SchedUlConfigIndParameters* params);
void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters *params);
void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params); /* from CSCHED */
void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params); void CschedCellConfigCnf(fapi_interface_t *, struct CschedCellConfigCnfParameters *params);
void CschedUeConfigCnf(fapi_interface_t *, struct CschedUeConfigCnfParameters *params);
#endif /* FF_MAC_H */ void CschedLcConfigCnf(fapi_interface_t *, struct CschedLcConfigCnfParameters *params);
void CschedLcReleaseCnf(fapi_interface_t *, struct CschedLcReleaseCnfParameters *params);
void CschedUeReleaseCnf(fapi_interface_t *, struct CschedUeReleaseCnfParameters *params);
void CschedUeConfigUpdateInd(fapi_interface_t *, struct CschedUeConfigUpdateIndParameters *params);
void CschedCellConfigUpdateInd(fapi_interface_t *, struct CschedCellConfigUpdateIndParameters *params);
/*@}*/
#endif /* FF_MAC_H */
targets/DOCS/Doxyfile
View file @ d25a7850
...@@ -772,6 +772,12 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \ ...@@ -772,6 +772,12 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \
$(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \ $(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/defs.h \ $(OPENAIR2_DIR)/LAYER2/MAC/defs.h \
$(OPENAIR2_DIR)/LAYER2/MAC/proto.h \ $(OPENAIR2_DIR)/LAYER2/MAC/proto.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-callback.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-common.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-csched-sap.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-sched-sap.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac.h \
$(OPENAIR2_DIR)/LAYER2/MAC/ff-mac-init.h \
$(OPENAIR2_DIR)/LAYER2/RLC/rlc.h \ $(OPENAIR2_DIR)/LAYER2/RLC/rlc.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am.h \
$(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \ $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment