srsLTE/lib/include/srslte/phy/fec/cbsegm.h

97 lines
3.3 KiB
C

/**
*
* \section COPYRIGHT
*
* Copyright 2013-2020 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 SRSLTE_CBSEGM_H
#define SRSLTE_CBSEGM_H
#include <stdbool.h>
#include <stdint.h>
#include "srslte/config.h"
#define SRSLTE_NOF_TC_CB_SIZES 188
typedef struct SRSLTE_API {
uint32_t F; ///< \brief Total number of the transport block bit
uint32_t C; ///< \brief Total number of code blocks
uint32_t K1; ///< \brief Code block size 1
uint32_t K2; ///< \brief Code block size 2
uint32_t K1_idx; ///< \brief Code block size index 1
uint32_t K2_idx; ///< \brief Code block size index 2
uint32_t C1; ///< \brief Number of code blocks of size 1
uint32_t C2; ///< \brief Number of code blocks of size 2
uint32_t tbs; ///< \brief Actual transport block size
uint32_t L_tb; ///< \brief Transport block CRC length
uint32_t L_cb; ///< \brief Code block CRC length
uint32_t Z; ///< \brief Lifting size, LDPC only
} srslte_cbsegm_t;
/**
* @brief Calculate code block Segmentation for LTE
*
* @remark Defined as in TS 36.212 V8.8.0 section 5.1.2 Code block segmentation and code block CRC attachment
*
* @param[out] s Output of code block segmentation calculation
* @param[in] tbs Input Transport Block Size in bits. CRC's will be added to this
* @return It returns SRSLTE_SUCCESS if the provided arguments are valid, otherwise it returns SRSLTE_ERROR code
*/
SRSLTE_API int srslte_cbsegm(srslte_cbsegm_t* s, uint32_t tbs);
/**
* @brief provides interleaver size Table 5.1.3-3 (36.212) index
*
* @remark Defined as in TS 36.212 V8.8.0 Table 5.1.3-3 Turbo code internal interleaver parameters
*
* @return It returns Turbo coder interleaver size if the provided arguments are valid, otherwise it returns
* SRSLTE_ERROR code
*/
SRSLTE_API int srslte_cbsegm_cbsize(uint32_t index);
/**
* @brief Check is code block size is valid for LTE Turbo Code
*
* @param[in] size Size of code block in bits
* @return true if Code Block size is allowed
*/
SRSLTE_API bool srslte_cbsegm_cbsize_isvalid(uint32_t size);
/**
* @brief Finds index of minimum K>=long_cb in Table 5.1.3-3 of 36.212
*
* @return I_TBS or error code
*/
SRSLTE_API int srslte_cbsegm_cbindex(uint32_t long_cb);
/**
* @brief Calculate code block Segmentation for NR LDPC base graph 1
*
* @remark Defined as in Section 5.2.2 of 38.212 V15.9.0
*
* @param[out] s Output of code block segmentation calculation
* @param[in] tbs Input Transport Block Size in bits. CRC's will be added to this
* @return It returns SRSLTE_SUCCESS if the provided arguments are valid, otherwise it returns SRSLTE_ERROR code
*/
SRSLTE_API int srslte_cbsegm_ldpc_bg1(srslte_cbsegm_t* s, uint32_t tbs);
/**
* @brief Calculate code block Segmentation for NR LDPC base graph 2
*
* @remark Defined as in Section 5.2.2 of 38.212 V15.9.0
*
* @param[out] s Output of code block segmentation calculation
* @param[in] tbs Input Transport Block Size in bits. CRC's will be added to this
* @return It returns SRSLTE_SUCCESS if the provided arguments are valid, otherwise it returns SRSLTE_ERROR code
*/
SRSLTE_API int srslte_cbsegm_ldpc_bg2(srslte_cbsegm_t* s, uint32_t tbs);
#endif // SRSLTE_CBSEGM_H