srsLTE/lib/include/srslte/phy/fec/turbodecoder_simd.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_SSE_
#define TURBODECODER_SSE_

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

//#define ENABLE_SIMD_INTER

// The constant SRSLTE_TDEC_NPAR defines the maximum number of parallel CB supported by all SIMD decoders 
#ifdef ENABLE_SIMD_INTER
  #include "srslte/phy/fec/turbodecoder_simd_inter.h"
  #ifdef LV_HAVE_AVX2
    #define SRSLTE_TDEC_NPAR_INTRA 2
  #else
    #define SRSLTE_TDEC_NPAR_INTRA 1
  #endif
#else
  #ifdef LV_HAVE_AVX2
    #define SRSLTE_TDEC_NPAR 2
  #else
    #define SRSLTE_TDEC_NPAR 1
  #endif
#endif

#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)

typedef struct SRSLTE_API {
  uint32_t max_long_cb;
  uint32_t max_par_cb; 
  int16_t *alpha;
  int16_t *branch;
} map_gen_t;

typedef struct SRSLTE_API {
  uint32_t max_long_cb;
  uint32_t max_par_cb; 
  
  map_gen_t dec;

  int16_t *app1[SRSLTE_TDEC_NPAR];
  int16_t *app2[SRSLTE_TDEC_NPAR];
  int16_t *ext1[SRSLTE_TDEC_NPAR];
  int16_t *ext2[SRSLTE_TDEC_NPAR];
  int16_t *syst[SRSLTE_TDEC_NPAR];
  int16_t *parity0[SRSLTE_TDEC_NPAR];
  int16_t *parity1[SRSLTE_TDEC_NPAR];
  
  int cb_mask; 
  int current_cbidx; 
  srslte_tc_interl_t interleaver[SRSLTE_NOF_TC_CB_SIZES];
  int n_iter[SRSLTE_TDEC_NPAR];
} srslte_tdec_simd_t;

SRSLTE_API int srslte_tdec_simd_init(srslte_tdec_simd_t * h, 
                                     uint32_t max_par_cb, 
                                     uint32_t max_long_cb);

SRSLTE_API void srslte_tdec_simd_free(srslte_tdec_simd_t * h);

SRSLTE_API int srslte_tdec_simd_reset(srslte_tdec_simd_t * h, 
                                      uint32_t long_cb);

SRSLTE_API int srslte_tdec_simd_get_nof_iterations_cb(srslte_tdec_simd_t * h, 
                                                      uint32_t cb_idx);

SRSLTE_API int srslte_tdec_simd_reset_cb(srslte_tdec_simd_t * h, 
                                         uint32_t cb_idx);

SRSLTE_API void srslte_tdec_simd_iteration(srslte_tdec_simd_t * h, 
                                           int16_t * input[SRSLTE_TDEC_NPAR], 
                                           uint32_t long_cb);

SRSLTE_API void srslte_tdec_simd_decision(srslte_tdec_simd_t * h, 
                                          uint8_t *output[SRSLTE_TDEC_NPAR], 
                                          uint32_t long_cb);

SRSLTE_API void srslte_tdec_simd_decision_byte(srslte_tdec_simd_t * h, 
                                               uint8_t *output[SRSLTE_TDEC_NPAR], 
                                               uint32_t long_cb); 

SRSLTE_API void srslte_tdec_simd_decision_byte_cb(srslte_tdec_simd_t * h, 
                                                  uint8_t *output, 
                                                  uint32_t cbidx, 
                                                  uint32_t long_cb); 

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

#endif