Cleanup MAC header files

- sorted out according to recurring logic that wants function
  prototypes in separate files from data struct and constants
  definitions, variables in separate .c files with inclusion
  of "extern" header files
- moved function prototypes to resective header files
- moved data structures and constants to respective header files
- merged unnecessary mac.h file into mac_defs.h @ MAC UE
- moved const variables suchs as tables to respective .c files
- moved extern references to respective extern.h files

openair1/PHY/defs_nr_UE.h

@@ -20,7 +20,7 @@
  */
 
 /*! \file PHY/defs_nr_UE.h
- \brief Top-level defines and structure definitions for nr ue
+ \brief Top-level constants and data structures definitions for NR UE
  \author Guy De Souza, H. WANG, A. Mico Pereperez
  \date 2018
  \version 0.1
@@ -123,6 +123,9 @@
 
 #define FRAME_PERIOD    100000000ULL
 #define DAQ_PERIOD      66667ULL
+#define DLSCH_RB_ALLOC    0x1fbf  // skip DC RB (total 23/25 RBs)
+#define DLSCH_RB_ALLOC_12 0x0aaa  // skip DC RB (total 23/25 RBs)
+#define NS_PER_SLOT       500000
 
 #undef MALLOC //there are two conflicting definitions, so we better make sure we don't use it at all
 

openair1/SCHED_NR_UE/defs.h

@@ -20,6 +20,7 @@
  */
 
 /*
+  \brief NR UE PHY functions prototypes
   \author R. Knopp, F. Kaltenberger
   \company EURECOM
   \email knopp@eurecom.fr

openair1/SCHED_NR_UE/phy_procedures_nr_ue.c

@@ -75,17 +75,10 @@ fifo_dump_emos_UE emos_dump_UE;
 #include "intertask_interface.h"
 #include "T.h"
 
-#define DLSCH_RB_ALLOC 0x1fbf  // skip DC RB (total 23/25 RBs)
-#define DLSCH_RB_ALLOC_12 0x0aaa  // skip DC RB (total 23/25 RBs)
-
-#define NS_PER_SLOT 500000
-
 char nr_mode_string[4][20] = {"NOT SYNCHED","PRACH","RAR","PUSCH"};
 
 const uint8_t nr_rv_round_map_ue[4] = {0, 2, 1, 3};
 
-extern double cpuf;
-
 #if defined(EXMIMO) || defined(OAI_USRP) || defined(OAI_BLADERF) || defined(OAI_LMSSDR) || defined(OAI_ADRV9371_ZC706)
 extern uint64_t downlink_frequency[MAX_NUM_CCs][4];
 #endif

openair2/LAYER2/NR_MAC_COMMON/nr_mac.h

@@ -20,7 +20,7 @@
  */
 
 /* \file       nr_mac.h
- * \brief      common MAC data structures, constant, and function prototype
+ * \brief      common MAC data structures and constants
  * \author     R. Knopp, K.H. HSU, G. Casati
  * \date       2019
  * \version    0.1
@@ -37,13 +37,17 @@
 #include <stdlib.h>
 #include <string.h>
 
+// Definitions for MAC control and data
 #define NR_BCCH_DL_SCH 3 // SI
-
 #define NR_BCCH_BCH 5    // MIB
-
 #define CCCH_PAYLOAD_SIZE_MAX 128
-
 #define RAR_PAYLOAD_SIZE_MAX  128
+#define MAX_BWP_SIZE          275
+
+typedef enum frequency_range_e {
+    FR1 = 0,
+    FR2
+} frequency_range_t;
 
 //  For both DL/UL-SCH
 //  Except:
@@ -339,6 +343,68 @@ typedef struct {
 #define NR_MAX_NUM_LCGID              8
 #define MAX_RLC_SDU_SUBHEADER_SIZE          3
 
+//===========
+// PRACH defs
+//===========
+
+// ===============================================
+// SSB to RO mapping public defines and structures
+// ===============================================
+#define MAX_SSB_PER_RO (16) // Maximum number of SSBs that can be mapped to a single RO
+#define MAX_TDM (7) // Maximum nb of PRACH occasions TDMed in a slot
+#define MAX_FDM (8) // Maximum nb of PRACH occasions FDMed in a slot
+
+// PRACH occasion details
+typedef struct prach_occasion_info {
+  uint8_t start_symbol; // 0 - 13 (14 symbols in a slot)
+  uint8_t fdm; // 0-7 (possible values of msg1-FDM: 1, 2, 4 or 8)
+  uint8_t slot; // 0 - 159 (maximum number of slots in a 10ms frame - @ 240kHz)
+  uint8_t frame; // 0 - 15 (maximum number of frames in a 160ms association pattern)
+  uint8_t mapped_ssb_idx[MAX_SSB_PER_RO]; // List of mapped SSBs
+  uint8_t nb_mapped_ssb;
+  uint16_t format; // RO preamble format
+} prach_occasion_info_t;
+
+// PRACH occasion slot details
+// A PRACH occasion slot is a series of PRACH occasions in time (symbols) and frequency
+typedef struct prach_occasion_slot {
+  prach_occasion_info_t prach_occasion[MAX_TDM][MAX_FDM]; // Starting symbol of each PRACH occasions in a slot
+  uint8_t nb_of_prach_occasion_in_time;
+  uint8_t nb_of_prach_occasion_in_freq;
+} prach_occasion_slot_t;
+
+//=========
+// DCI defs
+//=========
+
+typedef enum {
+  NR_DL_DCI_FORMAT_1_0 = 0,
+  NR_DL_DCI_FORMAT_1_1,
+  NR_DL_DCI_FORMAT_2_0,
+  NR_DL_DCI_FORMAT_2_1,
+  NR_DL_DCI_FORMAT_2_2,
+  NR_DL_DCI_FORMAT_2_3,
+  NR_UL_DCI_FORMAT_0_0,
+  NR_UL_DCI_FORMAT_0_1
+} nr_dci_format_t;
+
+typedef enum {
+  NR_RNTI_new = 0,
+  NR_RNTI_C,
+  NR_RNTI_RA,
+  NR_RNTI_P,
+  NR_RNTI_CS,
+  NR_RNTI_TC,
+  NR_RNTI_SP_CSI,
+  NR_RNTI_SI,
+  NR_RNTI_SFI,
+  NR_RNTI_INT,
+  NR_RNTI_TPC_PUSCH,
+  NR_RNTI_TPC_PUCCH,
+  NR_RNTI_TPC_SRS,
+  NR_RNTI_MCS_C,
+} nr_rnti_type_t;
+
 
 #endif /*__LAYER2_MAC_H__ */
 

openair2/LAYER2/NR_MAC_COMMON/nr_mac_common.h

@@ -20,13 +20,12 @@
  */
 
 /*! \file mac.h
-* \brief MAC data structures, constant, and function prototype
+* \brief common MAC function prototypes
 * \author Navid Nikaein and Raymond Knopp, WIE-TAI CHEN
 * \date Dec. 2019
 * \version 0.1
 * \company Eurecom
 * \email raymond.knopp@eurecom.fr
-
 */
 
 #ifndef __LAYER2_NR_MAC_COMMON_H__
@@ -36,73 +35,6 @@
 #include "NR_CellGroupConfig.h"
 #include "nr_mac.h"
 
-// ===============================================
-// SSB to RO mapping public defines and structures
-// ===============================================
-#define MAX_SSB_PER_RO (16) // Maximum number of SSBs that can be mapped to a single RO
-#define MAX_TDM (7) // Maximum nb of PRACH occasions TDMed in a slot
-#define MAX_FDM (8) // Maximum nb of PRACH occasions FDMed in a slot
-
-// Definitions for MAC control and data
-#define MAX_BWP_SIZE    275
-
-extern int64_t table_6_3_3_2_3_prachConfig_Index [256][9];
-
-typedef enum frequency_range_e {
-    FR1 = 0, 
-    FR2
-} frequency_range_t;
-
-// PRACH occasion details
-typedef struct prach_occasion_info {
-  uint8_t start_symbol; // 0 - 13 (14 symbols in a slot)
-  uint8_t fdm; // 0-7 (possible values of msg1-FDM: 1, 2, 4 or 8)
-  uint8_t slot; // 0 - 159 (maximum number of slots in a 10ms frame - @ 240kHz)
-  uint8_t frame; // 0 - 15 (maximum number of frames in a 160ms association pattern)
-  uint8_t mapped_ssb_idx[MAX_SSB_PER_RO]; // List of mapped SSBs
-  uint8_t nb_mapped_ssb;
-  uint16_t format; // RO preamble format
-} prach_occasion_info_t;
-
-// PRACH occasion slot details
-// A PRACH occasion slot is a series of PRACH occasions in time (symbols) and frequency
-typedef struct prach_occasion_slot {
-  prach_occasion_info_t prach_occasion[MAX_TDM][MAX_FDM]; // Starting symbol of each PRACH occasions in a slot
-  uint8_t nb_of_prach_occasion_in_time;
-  uint8_t nb_of_prach_occasion_in_freq;
-} prach_occasion_slot_t;
-
-// ========================================
-
-
-typedef enum {
-  NR_DL_DCI_FORMAT_1_0 = 0,
-  NR_DL_DCI_FORMAT_1_1,
-  NR_DL_DCI_FORMAT_2_0,
-  NR_DL_DCI_FORMAT_2_1,
-  NR_DL_DCI_FORMAT_2_2,
-  NR_DL_DCI_FORMAT_2_3,
-  NR_UL_DCI_FORMAT_0_0,
-  NR_UL_DCI_FORMAT_0_1
-} nr_dci_format_t;
-
-typedef enum {
-  NR_RNTI_new = 0,
-  NR_RNTI_C,
-  NR_RNTI_RA,
-  NR_RNTI_P,
-  NR_RNTI_CS,
-  NR_RNTI_TC,
-  NR_RNTI_SP_CSI,
-  NR_RNTI_SI,
-  NR_RNTI_SFI,
-  NR_RNTI_INT,
-  NR_RNTI_TPC_PUSCH,
-  NR_RNTI_TPC_PUCCH,
-  NR_RNTI_TPC_SRS,
-  NR_RNTI_MCS_C,
-} nr_rnti_type_t;
-
 uint16_t config_bandwidth(int mu, int nb_rb, int nr_band);
 
 void get_frame_type(uint16_t nr_bandP, uint8_t scs_index, lte_frame_type_t *current_type);

openair2/LAYER2/NR_MAC_UE/mac.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.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 mac.h
- * \brief MAC data structures, constant, and function prototype
- * \author R. Knopp, K.H. HSU
- * \date 2018
- * \version 0.1
- * \company Eurecom / NTUST
- * \email: knopp@eurecom.fr, kai-hsiang.hsu@eurecom.fr
- * \note
- * \warning
- */
-
-#ifndef __LAYER2_NR_UE_MAC_DEFS_H__
-#define __LAYER2_NR_UE_MAC_DEFS_H__
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-
-/*!\brief UE layer 2 status */
-typedef enum {
-    UE_CONNECTION_OK = 0,
-    UE_CONNECTION_LOST,
-    UE_PHY_RESYNCH,
-    UE_PHY_HO_PRACH
-} NR_UE_L2_STATE_t;
-
-#endif /*__LAYER2_NR_UE_MAC_DEFS_H__ */

openair2/LAYER2/NR_MAC_UE/mac_extern.h

@@ -92,4 +92,46 @@ extern uint8_t table_6_1_2_1_1_2_time_dom_res_alloc_A[16][3];
 //  for PDSCH from TS 38.214 subclause 5.1.2.1.1
 extern uint8_t table_5_1_2_1_1_2_time_dom_res_alloc_A[16][3];
 
+extern int64_t table_6_3_3_2_3_prachConfig_Index [256][9];
+
+extern const uint8_t table_9_2_2_1[16][8];
+
+// DCI
+extern const uint8_t table_7_3_1_1_2_2_3_4_5[64][20];
+extern const uint8_t table_7_3_1_1_2_12[14][3];
+extern const uint8_t table_7_3_1_1_2_13[10][4];
+extern const uint8_t table_7_3_1_1_2_14[3][5];
+extern const uint8_t table_7_3_1_1_2_15[4][6];
+extern const uint8_t table_7_3_1_1_2_16[12][2];
+extern const uint8_t table_7_3_1_1_2_17[7][3];
+extern const uint8_t table_7_3_1_1_2_18[3][4];
+extern const uint8_t table_7_3_1_1_2_19[2][5];
+extern const uint8_t table_7_3_1_1_2_20[28][3];
+extern const uint8_t table_7_3_1_1_2_21[19][4];
+extern const uint8_t table_7_3_1_1_2_22[6][5];
+extern const uint8_t table_7_3_1_1_2_23[5][6];
+extern const uint8_t table_7_3_2_3_3_1[12][5];
+extern const uint8_t table_7_3_2_3_3_2_oneCodeword[31][6];
+extern const uint8_t table_7_3_2_3_3_2_twoCodeword[4][10];
+extern const uint8_t table_7_3_2_3_3_3_oneCodeword[24][5];
+extern const uint8_t table_7_3_2_3_3_3_twoCodeword[2][7];
+extern const uint8_t table_7_3_2_3_3_4_oneCodeword[58][6];
+extern const uint8_t table_7_3_2_3_3_4_twoCodeword[6][10];
+
+extern const uint16_t table_7_2_1[16];
+
+extern dci_pdu_rel15_t *def_dci_pdu_rel15;
+
 extern dci_pdu_rel15_t *def_dci_pdu_rel15;
+
+extern void mac_rlc_data_ind(const module_id_t         module_idP,
+                             const rnti_t              rntiP,
+                             const eNB_index_t         eNB_index,
+                             const frame_t             frameP,
+                             const eNB_flag_t          enb_flagP,
+                             const MBMS_flag_t         MBMS_flagP,
+                             const logical_chan_id_t   channel_idP,
+                             char                     *buffer_pP,
+                             const tb_size_t           tb_sizeP,
+                             num_tb_t                  num_tbP,
+                             crc_t                    *crcs_pP);

openair2/LAYER2/NR_MAC_UE/mac_proto.h

@@ -34,11 +34,9 @@
 #define __LAYER2_MAC_UE_PROTO_H__
 
 #include "mac_defs.h"
-#include "mac.h"
 #include "PHY/defs_nr_UE.h"
 #include "RRC/NR_UE/rrc_defs.h"
 
-
 /**\brief decode mib pdu in NR_UE, from if_module ul_ind with P7 tx_ind message
    \param module_id      module id
    \param cc_id          component carrier id

openair2/LAYER2/NR_MAC_UE/nr_ra_procedures.c

@@ -30,8 +30,6 @@
  * \warning
  */
 
-#include "mac.h"
-
 /* Tools */
 #include "SIMULATION/TOOLS/sim.h"	// for taus
 

openair2/LAYER2/NR_MAC_UE/rar_tools_nrUE.c

@@ -41,32 +41,14 @@
 #include "common/ran_context.h"
 
 /* MAC */
-#include "NR_MAC_UE/mac.h"
 #include "NR_MAC_UE/mac_proto.h"
+#include "NR_MAC_UE/mac_extern.h"
 #include "NR_MAC_COMMON/nr_mac_extern.h"
 #include <common/utils/nr/nr_common.h>
 
 // #define DEBUG_RAR
 // #define DEBUG_MSG3
 
-// table 7.2-1 TS 38.321
-uint16_t table_7_2_1[16] = {
-  5,    // row index 0
-  10,   // row index 1
-  20,   // row index 2
-  30,   // row index 3
-  40,   // row index 4
-  60,   // row index 5
-  80,   // row index 6
-  120,  // row index 7
-  160,  // row index 8
-  240,  // row index 9
-  320,  // row index 10
-  480,  // row index 11
-  960,  // row index 12
-  1920, // row index 13
-};
-
 void nr_config_Msg3_pdu(NR_UE_MAC_INST_t *mac,
                         int Msg3_f_alloc,
                         uint8_t Msg3_t_alloc,

openair2/RRC/NR_UE/rrc_defs.h

@@ -39,7 +39,6 @@
 
 #include "platform_types.h"
 
-#include "NR_MAC_UE/mac.h"
 #include "NR_MAC_COMMON/nr_mac.h"
 #include "rrc_list.h"
 #include "NR_asn_constant.h"