srsRAN_4G/lib/include/srsran/phy/common/phy_common_sl.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2021 Software Radio Systems Limited
 *
 * By using this file, you agree to the terms and conditions set
 * forth in the LICENSE file which can be found at the top level of
 * the distribution.
 *
 */

/**********************************************************************************************
 *  File:         phy_common_sl.h
 *
 *  Description:  Common parameters and lookup functions for Sidelink PHY
 *
 *  Reference:    3GPP TS 36.211 version 15.3.0 Release 15
 *********************************************************************************************/

#ifndef SRSRAN_PHY_COMMON_SL_H
#define SRSRAN_PHY_COMMON_SL_H

/**
 *  \brief Common parameters and lookup functions for Sidelink PHY
 */

#include "srsran/phy/common/phy_common.h"

typedef enum SRSRAN_API {
  SRSRAN_SIDELINK_TM1 = 0,
  SRSRAN_SIDELINK_TM2,
  SRSRAN_SIDELINK_TM3,
  SRSRAN_SIDELINK_TM4
} srsran_sl_tm_t;

typedef enum SRSRAN_API {
  SRSRAN_SIDELINK_PSBCH = 0, // Physical Sidelink Broadcast Channel
  SRSRAN_SIDELINK_PSCCH,     // Physical Sidelink Control Channel
  SRSRAN_SIDELINK_PSSCH,     // Physical Sidelink Shared Channel
  SRSRAN_SIDELINK_PSDCH      // Physical Sidelink Discovery Channel
} srsran_sl_channels_t;

typedef struct SRSRAN_API {
  srsran_sl_tm_t tm;
  uint32_t       N_sl_id;
  uint32_t       nof_prb;
  srsran_cp_t    cp;
} srsran_cell_sl_t;

#define SRSRAN_SL_MAX_PERIOD_LENGTH 320 // SL-PeriodComm-r12 3GPP TS 36.331 Section 6.3.8
// SL-CommResourcePool: 3GPP TS 36.331 version 15.6.0 Release 15 Section 6.3.8
typedef struct SRSRAN_API {
  uint32_t period_length;

  uint32_t prb_num;
  uint32_t prb_start;
  uint32_t prb_end;

  uint8_t pscch_sf_bitmap[SRSRAN_SL_MAX_PERIOD_LENGTH];
  uint8_t pssch_sf_bitmap[SRSRAN_SL_MAX_PERIOD_LENGTH];

  uint32_t size_sub_channel;      // sizeSubchannel-r14
  uint32_t num_sub_channel;       // numSubchannel-r14
  uint32_t start_prb_sub_channel; // startRB-Subchannel-r14 offset
  bool     adjacency_pscch_pssch; // adjacencyPSCCH-PSSCH-r14

  uint32_t sf_bitmap_tm34_len;
  uint8_t  sf_bitmap_tm34[SRSRAN_SL_MAX_PERIOD_LENGTH]; // sl_Subframe_r14: 3GPP 36.331 Section 6.3.8
} srsran_sl_comm_resource_pool_t;

typedef enum SRSRAN_API {
  SRSRAN_SIDELINK_DATA_SYMBOL = 0,
  SRSRAN_SIDELINK_SYNC_SYMBOL,
  SRSRAN_SIDELINK_DMRS_SYMBOL,
  SRSRAN_SIDELINK_GUARD_SYMBOL
} srsran_sl_symbol_t;

#define SRSRAN_SL_DUPLEX_MODE_FDD (1)
#define SRSRAN_SL_DUPLEX_MODE_TDD (2)

#define SRSRAN_SLSS_SIDE_PEAK_OFFSET (0.005f)
#define SRSRAN_SLSS_SIDE_PEAK_THRESHOLD_HIGH (0.49f) // square(0.7), max 70% of main peak
#define SRSRAN_SLSS_SIDE_PEAK_THRESHOLD_LOW (0.09f)  // square(0.3), min 30% of main peak

#define SRSRAN_PSBCH_NOF_PRB (6)
#define SRSRAN_PSCCH_TM34_NOF_PRB (2)

#define SRSRAN_MIB_SL_LEN (40)     // TM1/2: 40 bits
#define SRSRAN_MIB_SL_V2X_LEN (48) // TM3/4: 48 bits
#define SRSRAN_MIB_SL_MAX_LEN (SRSRAN_MIB_SL_V2X_LEN)

#define SRSRAN_SL_TM12_DEFAULT_NUM_DMRS_SYMBOLS (2)
#define SRSRAN_SL_TM34_DEFAULT_NUM_DMRS_SYMBOLS (4) ///< In TM3/4, all channels have 4 DMRS by default

#define SRSRAN_PSBCH_TM12_NUM_DATA_SYMBOLS (8) // PSBCH is in 8 OFDM symbols (but only 7 are tx'ed)
#define SRSRAN_PSBCH_TM12_NUM_DATA_SYMBOLS_EXT                                                                         \
  (6) // PSBCH is in 7 OFDM symbols for extended cyclic prefix (but only 6 are tx'ed)
#define SRSRAN_PSBCH_TM12_NUM_DMRS_SYMBOLS (2) ///< PSBCH has 2 DMRS symbols
#define SRSRAN_PSBCH_TM12_NUM_SYNC_SYMBOLS (4) ///< Two symbols PSSS and two SSSS

#define SRSRAN_PSBCH_TM34_NUM_DATA_SYMBOLS (7) ///< SL-BCH is in 7 OFDM symbols (but only 6 are tx'ed)
#define SRSRAN_PSBCH_TM34_NUM_DMRS_SYMBOLS (3) ///< PSBCH has 3 DMRS symbols in TM3 and TM4
#define SRSRAN_PSBCH_TM34_NUM_SYNC_SYMBOLS (4) ///< Two symbols PSSS and two SSSS

#define SRSRAN_SCI_CRC_LEN (16)
#define SRSRAN_SCI_MAX_LEN (45)
#define SRSRAN_SCI_TM34_LEN (32)

#define SRSRAN_PSCCH_QM 2
#define SRSRAN_PSCCH_TM12_NOF_PRB (1)
#define SRSRAN_PSCCH_TM34_NOF_PRB (2)
#define SRSRAN_PSCCH_MAX_NOF_PRB (SRSRAN_PSCCH_TM34_NOF_PRB)
#define SRSRAN_PSCCH_SCRAMBLING_SEED (510) ///< Scrambling seed for PSCCH is 510

#define SRSRAN_PSCCH_TM12_NUM_DATA_SYMBOLS (12)
#define SRSRAN_PSCCH_TM12_NUM_DMRS_SYMBOLS (2)
#define SRSRAN_PSCCH_TM12_NUM_DATA_SYMBOLS_EXT (10)

#define SRSRAN_PSCCH_TM34_NUM_DATA_SYMBOLS (10)
#define SRSRAN_PSCCH_TM34_NUM_DMRS_SYMBOLS (4)

#define SRSRAN_PSCCH_TM12_NOF_CODED_BITS                                                                               \
  (SRSRAN_NRE * SRSRAN_PSCCH_TM12_NUM_DATA_SYMBOLS * SRSRAN_PSCCH_TM12_NOF_PRB * SRSRAN_PSCCH_QM)
#define SRSRAN_PSCCH_TM34_NOF_CODED_BITS                                                                               \
  (SRSRAN_NRE * SRSRAN_PSCCH_TM34_NUM_DATA_SYMBOLS * SRSRAN_PSCCH_TM34_NOF_PRB * SRSRAN_PSCCH_QM)
#define SRSRAN_PSCCH_MAX_CODED_BITS SRSRAN_MAX(SRSRAN_PSCCH_TM12_NOF_CODED_BITS, SRSRAN_PSCCH_TM34_NOF_CODED_BITS)

#define SRSRAN_PSSCH_MAX_QM 6
#define SRSRAN_PSSCH_CRC_LEN 24
#define SRSRAN_MAX_CODEWORD_LEN 168000   // 12 subcarriers * 100 PRB * 14 symbols * 10 bits, assuming 1024QAM
#define SRSRAN_SL_SCH_MAX_TB_LEN (48936) // 3GPP 36.306 v15.4.0 Table 4.1B-1
#define SRSRAN_PSSCH_MAX_CODED_BITS (3 * SRSRAN_TCOD_MAX_LEN_CB + SRSRAN_TCOD_TOTALTAIL)

#define SRSRAN_PSSCH_TM12_NUM_DATA_SYMBOLS (12) // PSSCH is in 12 OFDM symbols (but only 11 are tx'ed)
#define SRSRAN_PSSCH_TM12_NUM_DMRS_SYMBOLS (2)  // PSSCH has 2 DMRS symbols in TM1 and TM2

#define SRSRAN_PSSCH_TM12_NUM_DATA_SYMBOLS_CP_EXT                                                                      \
  (10) // PSSCH is in 10 OFDM symbols for extended cyclic prefix (but only 9 are tx'ed)
#define SRSRAN_PSSCH_TM12_NUM_DMRS_SYMBOLS_CP_EXT                                                                      \
  (2) // PSSCH has 2 DMRS symbols for extended cyclic prefix in TM1 and TM2

#define SRSRAN_PSSCH_TM34_NUM_DATA_SYMBOLS (10) // PSSCH is in 10 OFDM symbols (but only 9 are tx'ed)
#define SRSRAN_PSSCH_TM34_NUM_DMRS_SYMBOLS (4)  // PSSCH has 4 DMRS symbols in TM3 and TM4

SRSRAN_API int srsran_sl_group_hopping_f_gh(uint32_t f_gh[SRSRAN_NSLOTS_X_FRAME * 2], uint32_t N_x_id);
#define SRSRAN_PSCCH_MAX_NUM_DATA_SYMBOLS (SRSRAN_PSCCH_TM12_NUM_DATA_SYMBOLS)

SRSRAN_API bool srsran_slss_side_peak_pos_is_valid(uint32_t side_peak_pos,
                                                   uint32_t main_peak_pos,
                                                   uint32_t side_peak_delta_a,
                                                   uint32_t side_peak_delta_b);
SRSRAN_API bool srsran_slss_side_peak_value_is_valid(float side_peak_value, float threshold_low, float threshold_high);

SRSRAN_API int srsran_sl_tm_to_cell_sl_tm_t(srsran_cell_sl_t* q, uint32_t tm);

SRSRAN_API uint32_t srsran_sl_get_num_symbols(srsran_sl_tm_t tm, srsran_cp_t cp);
SRSRAN_API bool     srsran_psbch_is_symbol(srsran_sl_symbol_t type, srsran_sl_tm_t tm, uint32_t i, srsran_cp_t cp);
SRSRAN_API bool     srsran_pscch_is_symbol(srsran_sl_symbol_t type, srsran_sl_tm_t tm, uint32_t i, srsran_cp_t cp);
SRSRAN_API bool     srsran_pssch_is_symbol(srsran_sl_symbol_t type, srsran_sl_tm_t tm, uint32_t i, srsran_cp_t cp);

SRSRAN_API uint32_t srsran_sci_format0_sizeof(uint32_t nof_prb);

SRSRAN_API int srsran_sl_comm_resource_pool_get_default_config(srsran_sl_comm_resource_pool_t* q,
                                                               srsran_cell_sl_t                cell);

#endif // SRSRAN_PHY_COMMON_SL_H