/** * * \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. * */ #ifndef SRSRAN_PUCCH_NR_H #define SRSRAN_PUCCH_NR_H #include "srsran/phy/ch_estimation/chest_ul.h" #include "srsran/phy/common/phy_common_nr.h" #include "srsran/phy/common/zc_sequence.h" #include "srsran/phy/modem/modem_table.h" #include "srsran/phy/phch/uci_nr.h" /** * @brief Maximum number of symbols (without DMRS) that NR-PUCCH format 1 can transmit */ #define SRSRAN_PUCCH_NR_FORMAT1_N_MAX 7 typedef struct SRSRAN_API { srsran_uci_nr_args_t uci; uint32_t max_nof_prb; } srsran_pucch_nr_args_t; typedef struct SRSRAN_API { float rsrp; float rsrp_dBfs; float epre; float epre_dBfs; float norm_corr; } srsran_pucch_nr_measure_t; /** * @brief NR-PUCCH encoder/decoder object */ typedef struct SRSRAN_API { uint32_t max_prb; srsran_carrier_nr_t carrier; srsran_zc_sequence_lut_t r_uv_1prb; cf_t format1_w_i_m[SRSRAN_PUCCH_NR_FORMAT1_N_MAX][SRSRAN_PUCCH_NR_FORMAT1_N_MAX][SRSRAN_PUCCH_NR_FORMAT1_N_MAX]; srsran_modem_table_t bpsk; srsran_modem_table_t qpsk; srsran_uci_nr_t uci; uint8_t* b; cf_t* d; cf_t* ce; } srsran_pucch_nr_t; /** * @brief Initialises an NR-PUCCH encoder/decoder object * @param q Object * @param args PUCCH configuration arguments * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_init(srsran_pucch_nr_t* q, const srsran_pucch_nr_args_t* args); /** * @brief Initialises an NR-PUCCH encoder/decoder object * @param q Object * @param carrier * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_set_carrier(srsran_pucch_nr_t* q, const srsran_carrier_nr_t* carrier); /** * @brief Deallocates an NR-PUCCH encoder/decoder object * @param q Object */ SRSRAN_API void srsran_pucch_nr_free(srsran_pucch_nr_t* q); /** * @brief Computes the NR-PUCCH group sequence * @remark Implemented according to TS 38.211 clause 6.3.2.2.1 Group and sequence hopping * @param[in] carrier Serving cell and UL BWP configuration * @param[in] cfg PUCCH common configuration * @param[out] u_ Group sequence (u) * @param[out] v_ Base sequence (v) * @return SRSRAN_SUCCESS if provide arguments are right, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_group_sequence(const srsran_carrier_nr_t* carrier, const srsran_pucch_nr_common_cfg_t* cfg, uint32_t* u_, uint32_t* v_); /** * @brief Computes the NR alpha index (1-NRE) * @param[in] carrier Serving cell and UL BWP configuration * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] l OFDM Symbol, relative to the NR-PUCCH transmission start * @param[in] l_prime Initial OFDM symbol, relative to the transmission slot start * @param[in] m0 Initial cyclic shift * @param[in] m_cs Set to zero expect for format 0 * @param[out] alpha_idx Computed alpha index * @return SRSRAN_SUCCESS if provide arguments are right, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_alpha_idx(const srsran_carrier_nr_t* carrier, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, uint32_t l, uint32_t l_prime, uint32_t m0, uint32_t m_cs, uint32_t* alpha_idx); /** * @brief Encode and writes NR-PUCCH format 0 in the resource grid * @remark Described in TS 38.211 clause 6.3.2.3 PUCCH format 0 * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 0 resource * @param[in] m_cs Cyclic shift according to TS 38.213 clause 5 * @param[out] slot_symbols Resource grid of the given slot * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format0_encode(const srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, srsran_pucch_nr_resource_t* resource, uint32_t m_cs, cf_t* slot_symbols); /** * @brief Measures PUCCH format 0 in the resource grid * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 0 resource * @param[in] m_cs Cyclic shift according to TS 38.213 clause 5 * @param[in] slot_symbols Resource grid of the given slot * @param[out] measure Measurement structure * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format0_measure(const srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, srsran_pucch_nr_resource_t* resource, uint32_t m_cs, const cf_t* slot_symbols, srsran_pucch_nr_measure_t* measure); /** * @brief Get NR-PUCCH orthogonal sequence w * @remark Defined by TS 38.211 Table 6.3.2.4.1-2: Orthogonal sequences ... for PUCCH format 1 * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] n_pucch Number of PUCCH symbols * @param[in] i sequence index * @param m OFDM symbol index * @return Orthogonal sequence complex number if valid, NAN otherwise */ SRSRAN_API cf_t srsran_pucch_nr_format1_w(const srsran_pucch_nr_t* q, uint32_t n_pucch, uint32_t i, uint32_t m); /** * @brief Encodes and puts NR-PUCCH format 1 in the resource grid * @remark Described in TS 38.211 clause 6.3.2.4 PUCCH format 1 * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 1 resource * @param[in] b Bits to encode in the message * @param[in] nof_bits Number of bits to encode in the message * @param[out] slot_symbols Resource grid of the given slot * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format1_encode(const srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, const srsran_pucch_nr_resource_t* resource, uint8_t* b, uint32_t nof_bits, cf_t* slot_symbols); /** * @brief Decodes NR-PUCCH format 1 * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 2-4 resource * @param[in] chest_res Channel estimator result * @param[in] slot_symbols Resource grid of the given slot * @param[out] b Bits to decode * @param[in] nof_bits Number of bits to decode in the message * @param[out] norm_corr Normalised correlation * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format1_decode(srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, const srsran_pucch_nr_resource_t* resource, srsran_chest_ul_res_t* chest_res, cf_t* slot_symbols, uint8_t b[SRSRAN_PUCCH_NR_FORMAT1_MAX_NOF_BITS], uint32_t nof_bits, float* norm_corr); /** * @brief Encoder NR-PUCCH formats 2, 3 and 4. The NR-PUCCH format is selected by resource->format. * @param[in,out] q NR-PUCCH encoder/decoder object * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 1 resource * @param[in] uci_cfg Uplink Control Information configuration * @param[in] uci_value Uplink Control Information data * @param[out] slot_symbols Resource grid of the given slot * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format_2_3_4_encode(srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, const srsran_pucch_nr_resource_t* resource, const srsran_uci_cfg_nr_t* uci_cfg, const srsran_uci_value_nr_t* uci_value, cf_t* slot_symbols); /** * @brief Decode NR-PUCCH format 2, 3, and 4. The NR-PUCCH format is selected by resource->format. * @param q[in,out] q NR-PUCCH encoder/decoder * @param[in] cfg PUCCH common configuration * @param[in] slot slot configuration * @param[in] resource PUCCH format 2-4 resource * @param[in] uci_cfg Uplink Control Information configuration * @param[in] chest_res Channel estimator result * @param[in] slot_symbols Resource grid of the given slot * @param[out] uci_value Uplink Control Information data * @return SRSRAN_SUCCESS if successful, SRSRAN_ERROR code otherwise */ SRSRAN_API int srsran_pucch_nr_format_2_3_4_decode(srsran_pucch_nr_t* q, const srsran_pucch_nr_common_cfg_t* cfg, const srsran_slot_cfg_t* slot, const srsran_pucch_nr_resource_t* resource, const srsran_uci_cfg_nr_t* uci_cfg, srsran_chest_ul_res_t* chest_res, cf_t* slot_symbols, srsran_uci_value_nr_t* uci_value); SRSRAN_API uint32_t srsran_pucch_nr_info(const srsran_pucch_nr_resource_t* resource, const srsran_uci_data_nr_t* uci_data, char* str, uint32_t str_len); #endif // SRSRAN_PUCCH_NR_H