/** * * \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 ldpc_rm.h * \brief Declaration of the LDPC RateMatcher and RateDematcher. * \author Jesus Gomez * \date 2020 * * \copyright Software Radio Systems Limited * */ #ifndef SRSRAN_LDPCRM_H #define SRSRAN_LDPCRM_H #include "srsran/phy/common/phy_common.h" #include "srsran/phy/fec/ldpc/base_graph.h" /*! * \brief Describes a rate matcher or rate dematcher (K, F are ignored at rate matcher) */ typedef struct SRSRAN_API { void* ptr; /*!< \brief %Rate Matcher auxiliary registers. */ srsran_basegraph_t bg; /*!< \brief Current base graph. */ uint16_t ls; /*!< \brief Current lifting size. */ uint32_t N; /*!< \brief Codeword size. */ uint32_t E; /*!< \brief Rate-Matched codeword size. */ uint32_t K; /*!< \brief Codeblock size (including punctured and filler bits). */ uint32_t F; /*!< \brief Number of filler bits in the codeblock. */ uint32_t k0; /*!< \brief Starting position in the circular buffer. */ uint32_t mod_order; /*!< \brief Modulation order. */ uint32_t Ncb; /*!< \brief Limit to the number of bits in the circular buffer. */ } srsran_ldpc_rm_t; /*! * Initializes the Rate Matcher for the maximum rate-matched codeword length * \param[out] q A pointer to a srsran_ldpc_rm_t structure. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_tx_init(srsran_ldpc_rm_t* q); /*! * Carries out the actual rate-matching. * \param[in] q A pointer to the Rate-Matcher (a srsran_ldpc_rm_t structure * instance) that carries out the rate matching. * \param[in] input The codeword obtained from the ldpc encoder. * \param[out] output The rate-matched codeword resulting from the rate-matching * operation. * \param[in] E Rate-matched codeword length. * \param[in] bg; Current base graph. * \param[in] ls Current lifting size. * \param[in] rv Redundancy version 0,1,2,3. * \param[in] mod_type Modulation type. * \param[in] Nref Size of limited buffer. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_tx(srsran_ldpc_rm_t* q, const uint8_t* input, uint8_t* output, const uint32_t E, const srsran_basegraph_t bg, const uint32_t ls, const uint8_t rv, const srsran_mod_t mod_type, const uint32_t Nref); /*! * Initializes all the Rate DeMatcher variables. * \param[out] q A pointer to a srsran_ldpc_rm_t structure. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_init_f(srsran_ldpc_rm_t* q); /*! * Carries out the actual rate-dematching. * \param[in] q A pointer to the Rate-DeMatcher (a srsran_ldpc_rm_t structure * instance) that carries out the rate matching. * \param[in] input The LLRs obtained from the channel samples that correspond to * the codeword to be first, rate-dematched and then decoded. * \param[out] output The rate-dematched codeword resulting from the rate-dematching * operation. Shall be either initialized to all zeros or to the * result of previous redundancy versions is available. * \param[in] E Rate-matched codeword length. * \param[in] F Number of filler bits. * \param[in] bg; Current base graph. * \param[in] ls Current lifting size. * \param[in] rv Redundancy version 0,1,2,3. * \param[in] mod_type Modulation type. * \param[in] Nref Size of limited buffer. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_f(srsran_ldpc_rm_t* q, const float* input, float* output, const uint32_t E, const uint32_t F, const srsran_basegraph_t bg, const uint32_t ls, const uint8_t rv, const srsran_mod_t mod_type, const uint32_t Nref); /*! * Initializes all the Rate DeMatcher variables (short inputs). * \param[out] q A pointer to a srsran_ldpc_rm_t structure. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_init_s(srsran_ldpc_rm_t* q); /*! * Carries out the actual rate-dematching (short symbols). * \param[in] q A pointer to the Rate-DeMatcher (a srsran_ldpc_rm_t structure * instance) that carries out the rate matching. * \param[in] input The LLRs obtained from the channel samples that correspond to * the codeword to be first, rate-dematched and then decoded. * \param[out] output The rate-dematched codeword resulting from the rate-dematching * operation. Shall be either initialized to all zeros or to the * result of previous redundancy versions is available. * \param[in] E Rate-matched codeword length. * \param[in] F Number of filler bits. * \param[in] bg; Current base graph. * \param[in] ls Current lifting size. * \param[in] rv Redundancy version 0,1,2,3. * \param[in] mod_type Modulation type. * \param[in] Nref Size of limited buffer. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_s(srsran_ldpc_rm_t* q, const int16_t* input, int16_t* output, const uint32_t E, const uint32_t F, const srsran_basegraph_t bg, const uint32_t ls, const uint8_t rv, const srsran_mod_t mod_type, const uint32_t Nref); /*! * Initializes all the Rate DeMatcher variables (char inputs). * \param[out] q A pointer to a srsran_ldpc_rm_t structure. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_init_c(srsran_ldpc_rm_t* q); /*! * Carries out the actual rate-dematching (int8_t symbols). * \param[in] q A pointer to the Rate-DeMatcher (a srsran_ldpc_rm_t structure * instance) that carries out the rate matching. * \param[in] input The LLRs obtained from the channel samples that correspond to * the codeword to be first, rate-dematched and then decoded. * \param[out] output The rate-dematched codeword resulting from the rate-dematching * operation. Shall be either initialized to all zeros or to the * result of previous redundancy versions is available. * \param[in] E Rate-matched codeword length. * \param[in] F Number of filler bits. * \param[in] bg; Current base graph. * \param[in] ls Current lifting size. * \param[in] rv Redundancy version 0,1,2,3. * \param[in] mod_type Modulation type. * \param[in] Nref Size of limited buffer. * \return An integer: 0 if the function executes correctly, -1 otherwise. */ SRSRAN_API int srsran_ldpc_rm_rx_c(srsran_ldpc_rm_t* q, const int8_t* input, int8_t* output, const uint32_t E, const uint32_t F, const srsran_basegraph_t bg, const uint32_t ls, const uint8_t rv, const srsran_mod_t mod_type, const uint32_t Nref); /*! * The Rate Matcher "destructor": it frees all the resources allocated to the rate-matcher. * \param[in] q A pointer to the dismantled rate-matcher. */ SRSRAN_API void srsran_ldpc_rm_tx_free(srsran_ldpc_rm_t* q); /*! * The Rate Matcher "destructor": it frees all the resources allocated to the rate-dematcher. * \param[in] q A pointer to the dismantled rate-dematcher. */ SRSRAN_API void srsran_ldpc_rm_rx_free_f(srsran_ldpc_rm_t* q); /*! * The Rate Matcher "destructor" for short symbols: it frees all the resources allocated to the rate-dematcher. * \param[in] q A pointer to the dismantled rate-dematcher. */ SRSRAN_API void srsran_ldpc_rm_rx_free_s(srsran_ldpc_rm_t* q); /*! * The Rate Matcher "destructor" for int8_t symbols: it frees all the resources allocated to the rate-dematcher. * \param[in] q A pointer to the dismantled rate-dematcher. */ SRSRAN_API void srsran_ldpc_rm_rx_free_c(srsran_ldpc_rm_t* q); #endif // SRSRAN_LDPCENCODER_H