Add brief description for each added files

openair2/LAYER2/MAC/config_NB_IoT.c

+
+/*! \file config_NB_IoT.c
+ * \brief configuration primitives between RRC and MAC
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
+ *
+ */
+
 #include "LAYER2/MAC/defs_NB_IoT.h"
 #include "LAYER2/MAC/proto_NB_IoT.h"
 #include "LAYER2/MAC/extern_NB_IoT.h"

openair2/LAYER2/MAC/config_NB_IoT.h

+
+/*! \file config_NB_IoT.h
+ * \brief configured structures used by scheduler
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
+ *
+ */
+
 #ifndef _CONFIG_H_
 #define _CONFIG_H_
 

openair2/LAYER2/MAC/defs_NB_IoT.h

-/*
- * 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.0  (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
+
+/*! \file defs_NB_IoT.c
+ * \brief MAC layer structures
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
  *
- * 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 LAYER2/MAC/defs.h
-* \brief MAC data structures, constant, and function prototype
-* \author Navid Nikaein and Raymond Knopp
-* \date 2011
-* \version 0.5
-* \email navid.nikaein@eurecom.fr
-*/
-/** @defgroup _oai2  openair2 Reference Implementation
- * @ingroup _ref_implementation_
- * @{
  */
-/*@}*/
 #ifndef __LAYER2_MAC_DEFS_NB_IOT_H__
 #define __LAYER2_MAC_DEFS_NB_IOT_H__
 #ifdef USER_MODE

openair2/LAYER2/MAC/eNB_scheduler_NB_IoT.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.0  (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 eNB_scheduler_nb_iot.c
+/*! \file eNB_scheduler_NB_IoT.c
  * \brief top level of the scheduler, it scheduled in pdcch period based.
- * \author  
+ * \author  NTUST BMW Lab./
  * \date 2017
  * \email: 
- * \version 0.5
- * @ingroup _mac
+ * \version 1.0
  *
  */
 

openair2/LAYER2/MAC/eNB_scheduler_RA_NB_IoT.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.0  (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 eNB_scheduler_RA_NB_IoT.c
- * \brief primitives used for random access
- * \author  TaiwanTech
- * \date 2017 
+ * \brief functions used in Random access scheduling 
+ * \author  NTUST BMW Lab./
+ * \date 2017
  * \email: 
  * \version 1.0
- * @ingroup _mac
-
+ *
  */
 
 #include "defs_NB_IoT.h"

openair2/LAYER2/MAC/eNB_scheduler_bch_NB_IoT.c

-// function for schedule SI
+
+/*! \file eNB_scheduler_bch_NB_IoT.c
+ * \brief schedule functions for SIBs transmission in NB-IoT
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
+ *
+ */
 
 #include "defs_NB_IoT.h"
 #include "proto_NB_IoT.h"

openair2/LAYER2/MAC/eNB_scheduler_dlsch_NB_IoT.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.0  (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 eNB_scheduler_dlsch_NB_IoT.c
- * \brief procedures related to eNB for the DLSCH transport channel
- * \author  TaiwanTech
+ * \brief handle DL UE-specific scheduling
+ * \author  NTUST BMW Lab./
  * \date 2017
- * \email: navid.nikaein@eurecom.fr
+ * \email: 
  * \version 1.0
- * @ingroup _mac
-
+ *
  */
 
 #include "defs_NB_IoT.h"

openair2/LAYER2/MAC/eNB_scheduler_ulsch_NB_IoT.c

-/*! \file eNB_scheduler_ulsch.c
- * \brief eNB procedures for the ULSCH transport channel
- * \author Navid Nikaein and Raymond Knopp
- * \date 2010 - 2014
- * \email: navid.nikaein@eurecom.fr
- * \version 1.0
- * @ingroup _mac
 
+/*! \file eNB_scheduler_ulsch_NB_IoT.c
+ * \brief handle UL UE-specific scheduling
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
+ *
  */
 
 #include "defs_NB_IoT.h"

openair2/LAYER2/MAC/extern_NB_IoT.h

-/*
- * 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.0  (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
+
+/*! \file extern_NB_IoT.h
+ * \brief MAC extern
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
  *
- * 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 extern.h
-* \brief mac externs
-* \author  Navid Nikaein and Raymond Knopp
-* \date 2010 - 2014
-* \version 1.0
-* \email navid.nikaein@eurecom.fr
-* @ingroup _mac
-
-*/
-
 #ifndef __MAC_EXTERN_NB_IOT_H__
 #define __MAC_EXTERN_NB_IOT_H__
 

openair2/LAYER2/MAC/main_NB_IoT.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.0  (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 main_nb_iot.c
+/*! \file main_NB_IoT.c
  * \brief top init of Layer 2
- * \author  
+ * \author  NTUST BMW LAB./
  * \date 2017
  * \version 1.0
  * \email: 
- * @ingroup _mac
-
  */
 
 

openair2/LAYER2/MAC/schedule_tool_NB_IoT.c

+
+/*! \file schedule_tool_NB_IoT.c
+ * \brief scheduler helper function
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
+ *
+ */
+
 #include "defs_NB_IoT.h"
 #include "proto_NB_IoT.h"
 #include "extern_NB_IoT.h"

openair2/LAYER2/MAC/vars_NB_IoT.h

-/*
- * 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.0  (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
+
+/*! \file vars_NB_IoT.h
+ * \brief declare the MAC global variables
+ * \author  NTUST BMW Lab./
+ * \date 2017
+ * \email: 
+ * \version 1.0
  *
- * 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 vars.h
-* \brief mac vars
-* \author  Navid Nikaein and Raymond Knopp
-* \date 2010 - 2014
-* \version 1.0
-* \email navid.nikaein@eurecom.fr
-* @ingroup _mac
-
-*/
-
 
 #ifndef __MAC_VARS_NB_IOT_H__
 #define __MAC_VARS_NB_IOT_H__