Merge branch 'feature-31-ff-scheduler-api' of...

Merge branch 'feature-31-ff-scheduler-api' of https://gitlab.eurecom.fr/oai/openairinterface5g into feature-31-ff-scheduler-api

Conflicts:
	openair2/LAYER2/MAC/ff-mac.h

cmake_targets/CMakeLists.txt

@@ -233,7 +233,7 @@ if (${RTAI})
   set(RTAI_SOURCE sched_dlsch.c sched_rx_pdsch.c rt_wrapper.c vcd_signal_dumper.c log.c)
 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

openair2/LAYER2/MAC/ff-mac-callback.h

-#ifndef FF_MAC_CALLBACK_H
-#define FF_MAC_CALLBACK_H
-
-#if defined (__cplusplus)
-extern "C" {
-#endif
-
-/* these are the callback function types from the scheduler to openair */
-
-/* sched */
-typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params);
-typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
-
-/* csched */
-typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *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);
-typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
-typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params);
-typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params);
-typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params);
-
-#if defined (__cplusplus)
-}
-#endif
-
-#endif /* FF_MAC_CALLBACK_H */
+#ifndef FF_MAC_CALLBACK_H
+#define FF_MAC_CALLBACK_H
+
+/*! 
+ * @ingroup _fapi
+ */
+
+
+#if defined (__cplusplus)
+extern "C" {
+#endif
+
+/* these are the callback function types from the scheduler to openair */
+
+/* sched */
+typedef void (SchedDlConfigInd_callback_t)(void *callback_data, const struct SchedDlConfigIndParameters *params);
+typedef void (SchedUlConfigInd_callback_t)(void *callback_data, const struct SchedUlConfigIndParameters *params);
+
+/* csched */
+typedef void (CschedCellConfigCnf_callback_t)(void *callback_data, const struct CschedCellConfigCnfParameters *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);
+typedef void (CschedLcReleaseCnf_callback_t)(void *callback_data, const struct CschedLcReleaseCnfParameters *params);
+typedef void (CschedUeReleaseCnf_callback_t)(void *callback_data, const struct CschedUeReleaseCnfParameters *params);
+typedef void (CschedUeConfigUpdateInd_callback_t)(void *callback_data, const struct CschedUeConfigUpdateIndParameters *params);
+typedef void (CschedCellConfigUpdateInd_callback_t)(void *callback_data, const struct CschedCellConfigUpdateIndParameters *params);
+
+#if defined (__cplusplus)
+}
+#endif
+
+#endif /* FF_MAC_CALLBACK_H */

openair2/LAYER2/MAC/ff-mac-common.h

@@ -32,7 +32,7 @@
  * \date March 2015
  * \version 1.0
  * \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
  */
 
 
@@ -46,6 +46,11 @@
 extern "C" {
 #endif
 
+/** @defgroup _fapi  FAPI
+ * @ingroup _mac
+ * @{
+ */
+
 /**
  * Constants. See section 4.4
  */
@@ -613,6 +618,8 @@ struct PdcchOfdmSymbolCountListElement_s
 	uint8_t pdcchOfdmSymbolCount;
 };
 
+/*@}*/
+
 #if defined (__cplusplus)
 }
 #endif

openair2/LAYER2/MAC/ff-mac-csched-sap.h

@@ -32,7 +32,7 @@
  * \date March 2015
  * \version 1.0
  * \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
  */
 
 #ifndef FF_MAC_CSCHED_SAP_H
@@ -47,6 +47,11 @@
 extern "C" {
 #endif
 
+/** @defgroup _fapi  FAPI
+ * @ingroup _mac
+ * @{
+ */
+
 /**
  * Parameters of the API primitives
  */
@@ -387,6 +392,8 @@ void CschedUeConfigUpdateInd(const struct CschedUeConfigUpdateIndParameters *par
 void CschedCellConfigUpdateInd(const struct CschedCellConfigUpdateIndParameters *params);
 #endif
 
+/*@}*/
+
 #if defined (__cplusplus)
 }
 #endif

openair2/LAYER2/MAC/ff-mac-init.h

 #ifndef FF_MAC_INIT_H
 #define FF_MAC_INIT_H
 
+/*! 
+ * @ingroup _fapi
+ */
+
+
 #if defined (__cplusplus)
 extern "C" {
 #endif

openair2/LAYER2/MAC/ff-mac-sched-sap.h

@@ -32,7 +32,7 @@
  * \date March 2015
  * \version 1.0
  * \email: florian.kaltenberger@eurecom.fr
- * @ingroup _mac
+ * @ingroup _fapi
  */
 
 #ifndef FF_MAC_SCHED_SAP_H
@@ -47,6 +47,11 @@
 extern "C" {
 #endif
 
+/** @defgroup _fapi  FAPI
+ * @ingroup _mac
+ * @{
+ */
+
 /**
  * Parameters of the API primitives
  */
@@ -269,6 +274,8 @@ void SchedDlConfigInd(const struct SchedDlConfigIndParameters* params);
 void SchedUlConfigInd(const struct SchedUlConfigIndParameters* params);
 #endif
 
+/*@}*/
+
 #if defined (__cplusplus)
 }
 #endif

openair2/LAYER2/MAC/ff-mac.h

 #ifndef FF_MAC_H
 #define FF_MAC_H
 
+/** @defgroup _fapi  FAPI
+ * @ingroup _mac
+ * @{
+ */
+
 /* this file contains OAI related FAPI definitions */
 
 /* this is the public view of the FAPI's OAI interface */
@@ -46,4 +51,6 @@ void fapi_ul_lc_length(int frame, int subframe, int lcid, int length, int rnti);
 /* signal downlink ACKs/NACKs */
 void fapi_dl_ack_nack(int rnti, int harq_pid, int transport_block, int ack);
 
+/*@}*/
+
 #endif /* FF_MAC_H */

targets/DOCS/Doxyfile

@@ -772,6 +772,12 @@ INPUT                  = $(OPENAIR1_DIR)/PHY/defs.h \
                          $(OPENAIR1_DIR)/MAC_INTERFACE/defs.h \
                          $(OPENAIR2_DIR)/LAYER2/MAC/defs.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/AM_v9.3.0/rlc_am.h \
                          $(OPENAIR2_DIR)/LAYER2/RLC/AM_v9.3.0/rlc_am_constants.h \
@@ -1590,7 +1596,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = NO
+GENERATE_LATEX         = YES
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of