srsLTE/lib/include/srslte/phy/phch/pdsch_nr.h

/*
 * Copyright 2013-2020 Software Radio Systems Limited
 *
 * This file is part of srsLTE.
 *
 * 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:         pdsch_nr.h
 *
 *  Description:  Physical downlink shared channel for NR
 *
 *  Reference:    3GPP TS 38.211 V15.8.0 Sec. 7.3.1
 *****************************************************************************/

#ifndef srslte_pdsch_nr_H
#define srslte_pdsch_nr_H

#include "srslte/config.h"
#include "srslte/phy/ch_estimation/dmrs_pdsch.h"
#include "srslte/phy/phch/pdsch_cfg_nr.h"
#include "srslte/phy/phch/regs.h"
#include "srslte/phy/phch/sch_nr.h"
#include "srslte/phy/scrambling/scrambling.h"

/**
 * @brief PDSCH encoder and decoder initialization arguments
 */
typedef struct SRSLTE_API {
  srslte_sch_nr_args_t sch;
  bool                 measure_evm;
} srslte_pdsch_args_t;

/**
 * @brief PDSCH NR object
 */
typedef struct SRSLTE_API {
  uint32_t             max_prb;                         ///< Maximum number of allocated prb
  uint32_t             max_layers;                      ///< Maximum number of allocated layers
  uint32_t             max_cw;                          ///< Maximum number of allocated code words
  srslte_carrier_nr_t  carrier;                         ///< NR carrier configuration
  srslte_sch_nr_t      sch;                             ///< SCH Encoder/Decoder Object
  uint8_t*             b[SRSLTE_MAX_CODEWORDS];         ///< SCH Encoded and scrambled data
  cf_t*                d[SRSLTE_MAX_CODEWORDS];         ///< PDSCH modulated bits
  cf_t*                x[SRSLTE_MAX_LAYERS_NR];         ///< PDSCH modulated bits
  srslte_modem_table_t modem_tables[SRSLTE_MOD_NITEMS]; ///< Modulator tables
  srslte_evm_buffer_t* evm_buffer;
} srslte_pdsch_nr_t;

/**
 *
 */
typedef struct {
  uint8_t* payload;
  bool     crc;
  float    evm;
} srslte_pdsch_res_nr_t;

SRSLTE_API int srslte_pdsch_nr_init_enb(srslte_pdsch_nr_t* q, const srslte_pdsch_args_t* args);

SRSLTE_API int srslte_pdsch_nr_init_ue(srslte_pdsch_nr_t* q, const srslte_pdsch_args_t* args);

SRSLTE_API void srslte_pdsch_nr_free(srslte_pdsch_nr_t* q);

SRSLTE_API int
srslte_pdsch_nr_set_carrier(srslte_pdsch_nr_t* q, const srslte_carrier_nr_t* carrier, const srslte_sch_cfg_t* sch_cfg);

SRSLTE_API int srslte_pdsch_nr_encode(srslte_pdsch_nr_t*             q,
                                      const srslte_pdsch_cfg_nr_t*   cfg,
                                      const srslte_pdsch_grant_nr_t* grant,
                                      uint8_t*                       data[SRSLTE_MAX_TB],
                                      cf_t*                          sf_symbols[SRSLTE_MAX_PORTS]);

SRSLTE_API int srslte_pdsch_nr_decode(srslte_pdsch_nr_t*             q,
                                      const srslte_pdsch_cfg_nr_t*   cfg,
                                      const srslte_pdsch_grant_nr_t* grant,
                                      srslte_chest_dl_res_t*         channel,
                                      cf_t*                          sf_symbols[SRSLTE_MAX_PORTS],
                                      srslte_pdsch_res_nr_t          data[SRSLTE_MAX_TB]);

SRSLTE_API uint32_t srslte_pdsch_nr_grant_rx_info(srslte_pdsch_grant_nr_t* grant,
                                                  srslte_pdsch_res_nr_t    res[SRSLTE_MAX_CODEWORDS],
                                                  char*                    str,
                                                  uint32_t                 str_len);

SRSLTE_API uint32_t srslte_pdsch_nr_rx_info(srslte_pdsch_cfg_nr_t* cfg,
                                            srslte_pdsch_res_nr_t  res[SRSLTE_MAX_CODEWORDS],
                                            char*                  str,
                                            uint32_t               str_len);

SRSLTE_API uint32_t srslte_pdsch_nr_tx_info(srslte_pdsch_cfg_nr_t* cfg, char* str, uint32_t str_len);

#endif // srslte_pdsch_nr_H