srsRAN_4G/lib/include/srslte/phy/fec/turbodecoder.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2015 Software Radio Systems Limited
 *
 * \section LICENSE
 *
 * This file is part of the srsLTE library.
 *
 * srsLTE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsLTE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

/**********************************************************************************************
 *  File:         turbodecoder.h
 *
 *  Description:  Turbo Decoder.
 *                Parallel Concatenated Convolutional Code (PCCC) with two 8-state constituent
 *                encoders and one turbo code internal interleaver. The coding rate of turbo
 *                encoder is 1/3.
 *                MAP_GEN is the MAX-LOG-MAP generic implementation of the decoder.
 *
 *  Reference:    3GPP TS 36.212 version 10.0.0 Release 10 Sec. 5.1.3.2
 *********************************************************************************************/

#ifndef TURBODECODER_
#define TURBODECODER_

#include "srslte/config.h"
#include "srslte/phy/fec/tc_interl.h"
#include "srslte/phy/fec/cbsegm.h"

#define SRSLTE_TCOD_RATE 3
#define SRSLTE_TCOD_TOTALTAIL 12

#define SRSLTE_TCOD_MAX_LEN_CB     6144
#define SRSLTE_TCOD_MAX_LEN_CODED  (SRSLTE_TCOD_RATE*SRSLTE_TCOD_MAX_LEN_CB+SRSLTE_TCOD_TOTALTAIL)

#include "srslte/phy/fec/turbodecoder_gen.h"
#include "srslte/phy/fec/turbodecoder_simd.h"

typedef struct SRSLTE_API {
  float *input_conv;
  union {
    srslte_tdec_simd_t tdec_simd;
    srslte_tdec_gen_t  tdec_gen;
  };
} srslte_tdec_t;

SRSLTE_API int srslte_tdec_init(srslte_tdec_t * h, 
                                uint32_t max_long_cb);

SRSLTE_API void srslte_tdec_free(srslte_tdec_t * h);

SRSLTE_API int srslte_tdec_reset(srslte_tdec_t * h, 
                                 uint32_t long_cb);

SRSLTE_API int srslte_tdec_reset_cb(srslte_tdec_t * h, 
                                    uint32_t cb_idx);

SRSLTE_API int srslte_tdec_get_nof_iterations_cb(srslte_tdec_t * h, 
                                                 uint32_t cb_idx);

SRSLTE_API int srslte_tdec_get_nof_parallel(srslte_tdec_t * h); 

SRSLTE_API void srslte_tdec_iteration(srslte_tdec_t * h, 
                                      int16_t* input, 
                                      uint32_t long_cb);

SRSLTE_API void srslte_tdec_decision(srslte_tdec_t * h, 
                                     uint8_t *output, 
                                     uint32_t long_cb);

SRSLTE_API void srslte_tdec_decision_byte(srslte_tdec_t * h, 
                                          uint8_t *output, 
                                          uint32_t long_cb); 

SRSLTE_API int srslte_tdec_run_all(srslte_tdec_t * h, 
                                   int16_t * input, 
                                   uint8_t *output,
                                   uint32_t nof_iterations, 
                                   uint32_t long_cb);

SRSLTE_API void srslte_tdec_iteration_par(srslte_tdec_t * h, 
                                          int16_t* input[SRSLTE_TDEC_NPAR], 
                                          uint32_t long_cb);

SRSLTE_API void srslte_tdec_decision_par(srslte_tdec_t * h, 
                                         uint8_t *output[SRSLTE_TDEC_NPAR], 
                                         uint32_t long_cb);

SRSLTE_API void srslte_tdec_decision_byte_par(srslte_tdec_t * h, 
                                              uint8_t *output[SRSLTE_TDEC_NPAR], 
                                              uint32_t long_cb); 

SRSLTE_API void srslte_tdec_decision_byte_par_cb(srslte_tdec_t * h, 
                                                 uint8_t *output, 
                                                 uint32_t cb_idx, 
                                                 uint32_t long_cb);

SRSLTE_API int srslte_tdec_run_all_par(srslte_tdec_t * h, 
                                       int16_t * input[SRSLTE_TDEC_NPAR], 
                                       uint8_t *output[SRSLTE_TDEC_NPAR],
                                       uint32_t nof_iterations, 
                                       uint32_t long_cb);

#endif