baseband/fpga_lte_fec: fix API naming
authorMaxime Coquelin <maxime.coquelin@redhat.com>
Fri, 2 Oct 2020 08:59:31 +0000 (10:59 +0200)
committerAkhil Goyal <akhil.goyal@nxp.com>
Wed, 14 Oct 2020 19:29:59 +0000 (21:29 +0200)
DPDK APIs have to be prefixed with "rte_" in order to avoid
namespace pollution.

Let's fix it while fpga_lte_fec API is still experimental.
Fixes: efd453698c49 ("baseband/fpga_lte_fec: add driver for FEC on FPGA")

Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Reviewed-by: Tom Rix <trix@redhat.com>
app/test-bbdev/test_bbdev_perf.c
doc/guides/bbdevs/fpga_lte_fec.rst
doc/guides/rel_notes/release_20_11.rst
drivers/baseband/fpga_lte_fec/fpga_lte_fec.c
drivers/baseband/fpga_lte_fec/fpga_lte_fec.h
drivers/baseband/fpga_lte_fec/rte_pmd_bbdev_fpga_lte_fec_version.map

index 9245d6f..6e5535d 100644 (file)
@@ -580,14 +580,14 @@ add_bbdev_dev(uint8_t dev_id, struct rte_bbdev_info *info,
 #ifdef RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC
        if ((get_init_device() == true) &&
                (!strcmp(info->drv.driver_name, FPGA_LTE_PF_DRIVER_NAME))) {
 #ifdef RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC
        if ((get_init_device() == true) &&
                (!strcmp(info->drv.driver_name, FPGA_LTE_PF_DRIVER_NAME))) {
-               struct fpga_lte_fec_conf conf;
+               struct rte_fpga_lte_fec_conf conf;
                unsigned int i;
 
                printf("Configure FPGA LTE FEC Driver %s with default values\n",
                                info->drv.driver_name);
 
                /* clear default configuration before initialization */
                unsigned int i;
 
                printf("Configure FPGA LTE FEC Driver %s with default values\n",
                                info->drv.driver_name);
 
                /* clear default configuration before initialization */
-               memset(&conf, 0, sizeof(struct fpga_lte_fec_conf));
+               memset(&conf, 0, sizeof(struct rte_fpga_lte_fec_conf));
 
                /* Set PF mode :
                 * true if PF is used for data plane
 
                /* Set PF mode :
                 * true if PF is used for data plane
@@ -615,7 +615,7 @@ add_bbdev_dev(uint8_t dev_id, struct rte_bbdev_info *info,
                conf.flr_time_out = FLR_4G_TIMEOUT;
 
                /* setup FPGA PF with configuration information */
                conf.flr_time_out = FLR_4G_TIMEOUT;
 
                /* setup FPGA PF with configuration information */
-               ret = fpga_lte_fec_configure(info->dev_name, &conf);
+               ret = rte_fpga_lte_fec_configure(info->dev_name, &conf);
                TEST_ASSERT_SUCCESS(ret,
                                "Failed to configure 4G FPGA PF for bbdev %s",
                                info->dev_name);
                TEST_ASSERT_SUCCESS(ret,
                                "Failed to configure 4G FPGA PF for bbdev %s",
                                info->dev_name);
index 344a2cc..7731ad0 100644 (file)
@@ -168,12 +168,12 @@ queues, priorities, load balance, bandwidth and other settings necessary for the
 device to perform FEC functions.
 
 This configuration needs to be executed at least once after reboot or PCI FLR and can
 device to perform FEC functions.
 
 This configuration needs to be executed at least once after reboot or PCI FLR and can
-be achieved by using the function ``fpga_lte_fec_configure()``, which sets up the
-parameters defined in ``fpga_lte_fec_conf`` structure:
+be achieved by using the function ``rte_fpga_lte_fec_configure()``, which sets up the
+parameters defined in ``rte_fpga_lte_fec_conf`` structure:
 
 .. code-block:: c
 
 
 .. code-block:: c
 
-  struct fpga_lte_fec_conf {
+  struct rte_fpga_lte_fec_conf {
       bool pf_mode_en;
       uint8_t vf_ul_queues_number[FPGA_LTE_FEC_NUM_VFS];
       uint8_t vf_dl_queues_number[FPGA_LTE_FEC_NUM_VFS];
       bool pf_mode_en;
       uint8_t vf_ul_queues_number[FPGA_LTE_FEC_NUM_VFS];
       uint8_t vf_dl_queues_number[FPGA_LTE_FEC_NUM_VFS];
@@ -212,15 +212,15 @@ parameters defined in ``fpga_lte_fec_conf`` structure:
   the FLR time out then set this setting to 0x262=610.
 
 
   the FLR time out then set this setting to 0x262=610.
 
 
-An example configuration code calling the function ``fpga_lte_fec_configure()`` is shown
+An example configuration code calling the function ``rte_fpga_lte_fec_configure()`` is shown
 below:
 
 .. code-block:: c
 
 below:
 
 .. code-block:: c
 
-  struct fpga_lte_fec_conf conf;
+  struct rte_fpga_lte_fec_conf conf;
   unsigned int i;
 
   unsigned int i;
 
-  memset(&conf, 0, sizeof(struct fpga_lte_fec_conf));
+  memset(&conf, 0, sizeof(struct rte_fpga_lte_fec_conf));
   conf.pf_mode_en = 1;
 
   for (i = 0; i < FPGA_LTE_FEC_NUM_VFS; ++i) {
   conf.pf_mode_en = 1;
 
   for (i = 0; i < FPGA_LTE_FEC_NUM_VFS; ++i) {
@@ -233,7 +233,7 @@ below:
   conf.ul_load_balance = 64;
 
   /* setup FPGA PF */
   conf.ul_load_balance = 64;
 
   /* setup FPGA PF */
-  ret = fpga_lte_fec_configure(info->dev_name, &conf);
+  ret = rte_fpga_lte_fec_configure(info->dev_name, &conf);
   TEST_ASSERT_SUCCESS(ret,
       "Failed to configure 4G FPGA PF for bbdev %s",
       info->dev_name);
   TEST_ASSERT_SUCCESS(ret,
       "Failed to configure 4G FPGA PF for bbdev %s",
       info->dev_name);
index 28c2560..deca601 100644 (file)
@@ -309,6 +309,10 @@ API Changes
 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 
 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
   subsequently moved ``rte_ipsec`` lib from experimental to stable.
 
+* baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
+  ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
+  ``rte_fpga_lte_fec_conf``.
+
 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
   ``rte_fpga_5gnr_fec_conf``.
 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
   ``rte_fpga_5gnr_fec_conf``.
index 37018b9..71de399 100644 (file)
@@ -2432,10 +2432,10 @@ fpga_lte_fec_remove(struct rte_pci_device *pci_dev)
 }
 
 static inline void
 }
 
 static inline void
-set_default_fpga_conf(struct fpga_lte_fec_conf *def_conf)
+set_default_fpga_conf(struct rte_fpga_lte_fec_conf *def_conf)
 {
        /* clear default configuration before initialization */
 {
        /* clear default configuration before initialization */
-       memset(def_conf, 0, sizeof(struct fpga_lte_fec_conf));
+       memset(def_conf, 0, sizeof(struct rte_fpga_lte_fec_conf));
        /* Set pf mode to true */
        def_conf->pf_mode_en = true;
 
        /* Set pf mode to true */
        def_conf->pf_mode_en = true;
 
@@ -2450,15 +2450,15 @@ set_default_fpga_conf(struct fpga_lte_fec_conf *def_conf)
 
 /* Initial configuration of FPGA LTE FEC device */
 int
 
 /* Initial configuration of FPGA LTE FEC device */
 int
-fpga_lte_fec_configure(const char *dev_name,
-               const struct fpga_lte_fec_conf *conf)
+rte_fpga_lte_fec_configure(const char *dev_name,
+               const struct rte_fpga_lte_fec_conf *conf)
 {
        uint32_t payload_32, address;
        uint16_t payload_16;
        uint8_t payload_8;
        uint16_t q_id, vf_id, total_q_id, total_ul_q_id, total_dl_q_id;
        struct rte_bbdev *bbdev = rte_bbdev_get_named_dev(dev_name);
 {
        uint32_t payload_32, address;
        uint16_t payload_16;
        uint8_t payload_8;
        uint16_t q_id, vf_id, total_q_id, total_ul_q_id, total_dl_q_id;
        struct rte_bbdev *bbdev = rte_bbdev_get_named_dev(dev_name);
-       struct fpga_lte_fec_conf def_conf;
+       struct rte_fpga_lte_fec_conf def_conf;
 
        if (bbdev == NULL) {
                rte_bbdev_log(ERR,
 
        if (bbdev == NULL) {
                rte_bbdev_log(ERR,
index b2e423c..b35c7a4 100644 (file)
@@ -30,7 +30,7 @@ extern "C" {
 /**
  * Structure to pass FPGA 4G FEC configuration.
  */
 /**
  * Structure to pass FPGA 4G FEC configuration.
  */
-struct fpga_lte_fec_conf {
+struct rte_fpga_lte_fec_conf {
        /**< 1 if PF is used for dataplane, 0 for VFs */
        bool pf_mode_en;
        /**< Number of UL queues per VF */
        /**< 1 if PF is used for dataplane, 0 for VFs */
        bool pf_mode_en;
        /**< Number of UL queues per VF */
@@ -64,8 +64,8 @@ struct fpga_lte_fec_conf {
  */
 __rte_experimental
 int
  */
 __rte_experimental
 int
-fpga_lte_fec_configure(const char *dev_name,
-               const struct fpga_lte_fec_conf *conf);
+rte_fpga_lte_fec_configure(const char *dev_name,
+               const struct rte_fpga_lte_fec_conf *conf);
 
 #ifdef __cplusplus
 }
 
 #ifdef __cplusplus
 }
index a2ab086..b95b783 100644 (file)
@@ -5,6 +5,6 @@ DPDK_21 {
 EXPERIMENTAL {
        global:
 
 EXPERIMENTAL {
        global:
 
-       fpga_lte_fec_configure;
+       rte_fpga_lte_fec_configure;
 
 };
 
 };