drivers/baseband/fpga_5gnr_fec/rte_pmd_fpga_5gnr_fec.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2020 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_PMD_FPGA_5GNR_FEC_H_
   6 #define _RTE_PMD_FPGA_5GNR_FEC_H_
   7
   8 #include <stdint.h>
   9 #include <stdbool.h>
  10
  11 /**
  12  * @file rte_pmd_fpga_5gnr_fec.h
  13  *
  14  * Interface for Intel(R) FGPA 5GNR FEC device configuration at the host level,
  15  * directly accessible by the application.
  16  * Configuration related to 5GNR functionality is done through
  17  * librte_bbdev library.
  18  *
  19  * @warning
  20  * @b EXPERIMENTAL: this API may change without prior notice
  21  */
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /** Number of Virtual Functions FGPA 4G FEC supports */
  28 #define FPGA_5GNR_FEC_NUM_VFS 8
  29
  30 /**
  31  * Structure to pass FPGA 4G FEC configuration.
  32  */
  33 struct rte_fpga_5gnr_fec_conf {
  34         /** 1 if PF is used for dataplane, 0 for VFs */
  35         bool pf_mode_en;
  36         /** Number of UL queues per VF */
  37         uint8_t vf_ul_queues_number[FPGA_5GNR_FEC_NUM_VFS];
  38         /** Number of DL queues per VF */
  39         uint8_t vf_dl_queues_number[FPGA_5GNR_FEC_NUM_VFS];
  40         /** UL bandwidth. Needed for schedule algorithm */
  41         uint8_t ul_bandwidth;
  42         /** DL bandwidth. Needed for schedule algorithm */
  43         uint8_t dl_bandwidth;
  44         /** UL Load Balance */
  45         uint8_t ul_load_balance;
  46         /** DL Load Balance */
  47         uint8_t dl_load_balance;
  48 };
  49
  50 /**
  51  * Configure Intel(R) FPGA 5GNR FEC device
  52  *
  53  * @param dev_name
  54  *   The name of the device. This is the short form of PCI BDF, e.g. 00:01.0.
  55  *   It can also be retrieved for a bbdev device from the dev_name field in the
  56  *   rte_bbdev_info structure returned by rte_bbdev_info_get().
  57  * @param conf
  58  *   Configuration to apply to FPGA 4G FEC.
  59  *
  60  * @return
  61  *   Zero on success, negative value on failure.
  62  */
  63 __rte_experimental
  64 int
  65 rte_fpga_5gnr_fec_configure(const char *dev_name,
  66                 const struct rte_fpga_5gnr_fec_conf *conf);
  67
  68 #ifdef __cplusplus
  69 }
  70 #endif
  71
  72 #endif /* _RTE_PMD_FPGA_5GNR_FEC_H_ */