openairinterface5g/openair2/PHY_INTERFACE/IF_Module.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 openair2/PHY_INTERFACE/IF_Module.h
* \brief data structures for PHY/MAC interface modules
* \author EURECOM/NTUST
* \date 2017
* \version 0.1
* \company Eurecom
* \email: raymond.knopp@eurecom.fr
* \note
* \warning
*/
#ifndef __IF_MODULE__H__
#define __IF_MODULE__H__


#include <stdint.h>
#include <sched.h>
//#include "openair1/PHY/LTE_TRANSPORT/transport_eNB.h"
#include "nfapi_interface.h"
#include "platform_types.h"
#include <common/utils/threadPool/thread-pool.h>

#define MAX_NUM_DL_PDU 100
#define MAX_NUM_UL_PDU 100
#define MAX_NUM_HI_DCI0_PDU 100
#define MAX_NUM_TX_REQUEST_PDU 100

#define MAX_NUM_HARQ_IND 100
#define MAX_NUM_CRC_IND 100
#define MAX_NUM_SR_IND 100
#define MAX_NUM_CQI_IND 100
#define MAX_NUM_RACH_IND 100
#define MAX_NUM_SRS_IND 100

typedef struct {
  /// Module ID
  module_id_t module_id;
  /// CC ID
  int CC_id;
  /// frame
  frame_t frame;
  /// subframe
  sub_frame_t subframe;

  /// harq indication list
  nfapi_harq_indication_t harq_ind;

  /// crc indication list
  nfapi_crc_indication_t crc_ind;

  /// SR indication list
  nfapi_sr_indication_t sr_ind;

  /// CQI indication list
  nfapi_cqi_indication_t cqi_ind;

  /// RACH indication list
  nfapi_rach_indication_t rach_ind;
  /// RACH indication list for BR UEs
  nfapi_rach_indication_t rach_ind_br;
  /// SRS indication list
  nfapi_srs_indication_body_t srs_ind;

  /// RX indication
  nfapi_rx_indication_t rx_ind;

} UL_IND_t;

// Downlink subframe P7
#define NUM_NFAPI_SUBFRAME 10
typedef struct {
  /// harq indication list
  nfapi_harq_indication_t harq_ind[NUM_NFAPI_SUBFRAME];

  /// crc indication list
  nfapi_crc_indication_t crc_ind[NUM_NFAPI_SUBFRAME];

  /// SR indication list
  nfapi_sr_indication_t sr_ind[NUM_NFAPI_SUBFRAME];

  /// CQI indication list
  nfapi_cqi_indication_t cqi_ind[NUM_NFAPI_SUBFRAME];

  /// RACH indication list
  nfapi_rach_indication_t rach_ind[NUM_NFAPI_SUBFRAME];

  /// RX indication
  nfapi_rx_indication_t rx_ind[NUM_NFAPI_SUBFRAME];

} UL_RCC_IND_t;

typedef struct {
  /// Module ID
  module_id_t module_id;
  /// CC ID
  uint8_t CC_id;
  /// frame
  frame_t frame;
  /// subframe
  sub_frame_t subframe;
  /// nFAPI DL Config Request
  nfapi_dl_config_request_t *DL_req;
  /// nFAPI UL Config Request
  nfapi_ul_config_request_t *UL_req;
  /// nFAPI HI_DCI Request
  nfapi_hi_dci0_request_t *HI_DCI0_req;
  /// Pointers to DL SDUs
  nfapi_tx_request_t *TX_req;
  /// Pointers to ue_release
  nfapi_ue_release_request_t *UE_release_req;
} Sched_Rsp_t;

typedef struct {
    uint8_t Mod_id;
    int CC_id;
    nfapi_config_request_t *cfg;
} PHY_Config_t;
#include <targets/ARCH/COMMON/common_lib.h>

typedef struct IF_Module_s{
//define the function pointer
  void (*UL_indication)(UL_IND_t *UL_INFO, void *proc);
  void (*schedule_response)(Sched_Rsp_t *Sched_INFO, void *proc);
  void (*PHY_config_req)(PHY_Config_t* config_INFO);

  void (*PHY_config_update_sib2_req)(PHY_Config_t* config_INFO);
  void (*PHY_config_update_sib13_req)(PHY_Config_t* config_INFO);
  uint32_t CC_mask;
  uint16_t current_frame;
  uint8_t current_subframe;
  pthread_mutex_t if_mutex;
} IF_Module_t;

// These mutex is used for multiple UEs L2 FAPI simulator.
// Each UEs set these value in UL and UL_INFO is shared in all UE's thread.
typedef struct {
  pthread_mutex_t rx_mutex;
  pthread_mutex_t crc_mutex;
  pthread_mutex_t sr_mutex;
  pthread_mutex_t harq_mutex;
  pthread_mutex_t cqi_mutex;
  pthread_mutex_t rach_mutex;
} FILL_UL_INFO_MUTEX_t;

/*Initial */
IF_Module_t *IF_Module_init(int Mod_id);
void IF_Module_kill(int Mod_id);

/*Interface for uplink, transmitting the Preamble(list), ULSCH SDU, NAK, Tick (trigger scheduler)
 */
void UL_indication(UL_IND_t *UL_INFO, void *proc);

/*Interface for Downlink, transmitting the DLSCH SDU, DCI SDU*/
void Schedule_Response(Sched_Rsp_t *Sched_INFO);

#endif