[v2,1/4] raw/ifpga: remove experimental tag from ifpga APIs

Message ID 1652862549-13131-2-git-send-email-wei.huang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series Support OFS card |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Wei Huang May 18, 2022, 8:29 a.m. UTC
  These APIs are introduced in DPDK 21.05 and have been tested in several
release, experimental tag can be formally removed.

Signed-off-by: Wei Huang <wei.huang@intel.com>
Acked-by: Tianfei Zhang <tianfei.zhang@intel.com>
---
 drivers/raw/ifpga/rte_pmd_ifpga.h | 48 ---------------------------------------
 drivers/raw/ifpga/version.map     |  7 ++----
 2 files changed, 2 insertions(+), 53 deletions(-)
  

Comments

Zhang, Tianfei May 25, 2022, 3:22 a.m. UTC | #1
> -----Original Message-----
> From: Huang, Wei <wei.huang@intel.com>
> Sent: Wednesday, May 18, 2022 4:29 PM
> To: dev@dpdk.org; thomas@monjalon.net; nipun.gupta@nxp.com;
> hemant.agrawal@nxp.com
> Cc: stable@dpdk.org; Xu, Rosen <rosen.xu@intel.com>; Zhang, Tianfei
> <tianfei.zhang@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>; Huang, Wei
> <wei.huang@intel.com>
> Subject: [PATCH v2 1/4] raw/ifpga: remove experimental tag from ifpga APIs
> 
> These APIs are introduced in DPDK 21.05 and have been tested in several
> release, experimental tag can be formally removed.
> 
> Signed-off-by: Wei Huang <wei.huang@intel.com>
> Acked-by: Tianfei Zhang <tianfei.zhang@intel.com>
It is better that you can add Acked Tag after I acked in maillist.
> ---
>  drivers/raw/ifpga/rte_pmd_ifpga.h | 48 ---------------------------------------
>  drivers/raw/ifpga/version.map     |  7 ++----
>  2 files changed, 2 insertions(+), 53 deletions(-)
> 
> diff --git a/drivers/raw/ifpga/rte_pmd_ifpga.h
> b/drivers/raw/ifpga/rte_pmd_ifpga.h
> index 47d66ba..3fa5d34 100644
> --- a/drivers/raw/ifpga/rte_pmd_ifpga.h
> +++ b/drivers/raw/ifpga/rte_pmd_ifpga.h
> @@ -68,9 +68,6 @@
>  } rte_pmd_ifpga_phy_info;
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Get raw device ID from PCI address string like 'Domain:Bus:Dev.Func'
>   *
>   * @param pci_addr
> @@ -82,14 +79,10 @@
>   *   - (-EINVAL) if bad parameter.
>   *   - (-ENODEV) if FPGA is not probed by ifpga driver.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_get_dev_id(const char *pci_addr, uint16_t *dev_id);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Get current RSU status of the specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -103,14 +96,10 @@
>   *   - (-ENODEV) if dev_id is invalid.
>   *   - (-ENOMEM) if share data is not initialized.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_get_rsu_status(uint16_t dev_id, uint32_t *stat, uint32_t *prog);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Set current RSU status of the specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -124,14 +113,10 @@
>   *   - (-ENODEV) if dev_id is invalid.
>   *   - (-ENOMEM) if share data is not initialized.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_set_rsu_status(uint16_t dev_id, uint32_t stat, uint32_t prog);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Get FPGA property of specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -144,14 +129,10 @@
>   *   - (-EBUSY) if FPGA is rebooting.
>   *   - (-EIO) if failed to access hardware.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_get_property(uint16_t dev_id, rte_pmd_ifpga_prop *prop);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Get PHY information of specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -164,14 +145,10 @@
>   *   - (-EBUSY) if FPGA is rebooting.
>   *   - (-EIO) if failed to access hardware.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_get_phy_info(uint16_t dev_id, rte_pmd_ifpga_phy_info *info);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Update image flash of specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -187,15 +164,11 @@
>   *   - (-EBUSY) if FPGA is updating or rebooting.
>   *   - (-EIO) if failed to open image file.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_update_flash(uint16_t dev_id, const char *image,
>  	uint64_t *status);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Stop flash update of specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -208,14 +181,10 @@
>   *   - (-EINVAL) if bad parameter.
>   *   - (-EAGAIN) if failed with force.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_stop_update(uint16_t dev_id, int force);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Check current Intel FPGA status and change it to reboot status if it is idle
>   *
>   * @param dev_id
> @@ -226,14 +195,10 @@
>   *   - (-ENOMEM) if share data is not initialized.
>   *   - (-EBUSY) if FPGA is updating or rebooting.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_reboot_try(uint16_t dev_id);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Trigger full reconfiguration of specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -252,28 +217,20 @@
>   *   - (-EINVAL) if bad parameter.
>   *   - (-EBUSY) if failed to access BMC register.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_reload(uint16_t dev_id, int type, int page);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Get PCI bus the Intel FPGA driver register to
>   *
>   * @return
>   *   - (valid pointer) if successful.
>   *   - (NULL) if the Intel FPGA driver is not registered to any PCI bus.
>   */
> -__rte_experimental
>  const struct rte_pci_bus *
>  rte_pmd_ifpga_get_pci_bus(void);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Perform PR (partial reconfiguration) on specified Intel FPGA device
>   *
>   * @param dev_id
> @@ -287,17 +244,12 @@
>   *   - (-EINVAL) if bad parameter or operation failed.
>   *   - (-ENOMEM) if failed to allocate memory.
>   */
> -__rte_experimental
>  int
>  rte_pmd_ifpga_partial_reconfigure(uint16_t dev_id, int port, const char *file);
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> - *
>   * Free software resources allocated by Intel FPGA PMD
>   */
> -__rte_experimental
>  void
>  rte_pmd_ifpga_cleanup(void);
> 
> diff --git a/drivers/raw/ifpga/version.map b/drivers/raw/ifpga/version.map
> index a1a6be2..ff71a45 100644
> --- a/drivers/raw/ifpga/version.map
> +++ b/drivers/raw/ifpga/version.map
> @@ -1,11 +1,6 @@
>  DPDK_22 {
> -	local: *;
> -};
> -
> -EXPERIMENTAL {
>  	global:
> 
> -	# added in 21.05
>  	rte_pmd_ifpga_get_dev_id;
>  	rte_pmd_ifpga_get_rsu_status;
>  	rte_pmd_ifpga_set_rsu_status;
> @@ -18,4 +13,6 @@ EXPERIMENTAL {
>  	rte_pmd_ifpga_get_pci_bus;
>  	rte_pmd_ifpga_partial_reconfigure;
>  	rte_pmd_ifpga_cleanup;
> +
> +	local: *;
>  };
> --
> 1.8.3.1

It looks good for me, you can add:
Acked-by: Tianfei Zhang <tianfei.zhang@intel.com>
  

Patch

diff --git a/drivers/raw/ifpga/rte_pmd_ifpga.h b/drivers/raw/ifpga/rte_pmd_ifpga.h
index 47d66ba..3fa5d34 100644
--- a/drivers/raw/ifpga/rte_pmd_ifpga.h
+++ b/drivers/raw/ifpga/rte_pmd_ifpga.h
@@ -68,9 +68,6 @@ 
 } rte_pmd_ifpga_phy_info;
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Get raw device ID from PCI address string like 'Domain:Bus:Dev.Func'
  *
  * @param pci_addr
@@ -82,14 +79,10 @@ 
  *   - (-EINVAL) if bad parameter.
  *   - (-ENODEV) if FPGA is not probed by ifpga driver.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_get_dev_id(const char *pci_addr, uint16_t *dev_id);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Get current RSU status of the specified Intel FPGA device
  *
  * @param dev_id
@@ -103,14 +96,10 @@ 
  *   - (-ENODEV) if dev_id is invalid.
  *   - (-ENOMEM) if share data is not initialized.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_get_rsu_status(uint16_t dev_id, uint32_t *stat, uint32_t *prog);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Set current RSU status of the specified Intel FPGA device
  *
  * @param dev_id
@@ -124,14 +113,10 @@ 
  *   - (-ENODEV) if dev_id is invalid.
  *   - (-ENOMEM) if share data is not initialized.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_set_rsu_status(uint16_t dev_id, uint32_t stat, uint32_t prog);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Get FPGA property of specified Intel FPGA device
  *
  * @param dev_id
@@ -144,14 +129,10 @@ 
  *   - (-EBUSY) if FPGA is rebooting.
  *   - (-EIO) if failed to access hardware.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_get_property(uint16_t dev_id, rte_pmd_ifpga_prop *prop);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Get PHY information of specified Intel FPGA device
  *
  * @param dev_id
@@ -164,14 +145,10 @@ 
  *   - (-EBUSY) if FPGA is rebooting.
  *   - (-EIO) if failed to access hardware.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_get_phy_info(uint16_t dev_id, rte_pmd_ifpga_phy_info *info);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Update image flash of specified Intel FPGA device
  *
  * @param dev_id
@@ -187,15 +164,11 @@ 
  *   - (-EBUSY) if FPGA is updating or rebooting.
  *   - (-EIO) if failed to open image file.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_update_flash(uint16_t dev_id, const char *image,
 	uint64_t *status);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Stop flash update of specified Intel FPGA device
  *
  * @param dev_id
@@ -208,14 +181,10 @@ 
  *   - (-EINVAL) if bad parameter.
  *   - (-EAGAIN) if failed with force.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_stop_update(uint16_t dev_id, int force);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Check current Intel FPGA status and change it to reboot status if it is idle
  *
  * @param dev_id
@@ -226,14 +195,10 @@ 
  *   - (-ENOMEM) if share data is not initialized.
  *   - (-EBUSY) if FPGA is updating or rebooting.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_reboot_try(uint16_t dev_id);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Trigger full reconfiguration of specified Intel FPGA device
  *
  * @param dev_id
@@ -252,28 +217,20 @@ 
  *   - (-EINVAL) if bad parameter.
  *   - (-EBUSY) if failed to access BMC register.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_reload(uint16_t dev_id, int type, int page);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Get PCI bus the Intel FPGA driver register to
  *
  * @return
  *   - (valid pointer) if successful.
  *   - (NULL) if the Intel FPGA driver is not registered to any PCI bus.
  */
-__rte_experimental
 const struct rte_pci_bus *
 rte_pmd_ifpga_get_pci_bus(void);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Perform PR (partial reconfiguration) on specified Intel FPGA device
  *
  * @param dev_id
@@ -287,17 +244,12 @@ 
  *   - (-EINVAL) if bad parameter or operation failed.
  *   - (-ENOMEM) if failed to allocate memory.
  */
-__rte_experimental
 int
 rte_pmd_ifpga_partial_reconfigure(uint16_t dev_id, int port, const char *file);
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
- *
  * Free software resources allocated by Intel FPGA PMD
  */
-__rte_experimental
 void
 rte_pmd_ifpga_cleanup(void);
 
diff --git a/drivers/raw/ifpga/version.map b/drivers/raw/ifpga/version.map
index a1a6be2..ff71a45 100644
--- a/drivers/raw/ifpga/version.map
+++ b/drivers/raw/ifpga/version.map
@@ -1,11 +1,6 @@ 
 DPDK_22 {
-	local: *;
-};
-
-EXPERIMENTAL {
 	global:
 
-	# added in 21.05
 	rte_pmd_ifpga_get_dev_id;
 	rte_pmd_ifpga_get_rsu_status;
 	rte_pmd_ifpga_set_rsu_status;
@@ -18,4 +13,6 @@  EXPERIMENTAL {
 	rte_pmd_ifpga_get_pci_bus;
 	rte_pmd_ifpga_partial_reconfigure;
 	rte_pmd_ifpga_cleanup;
+
+	local: *;
 };