raw/ifpga/base: add PMCI base driver

[dpdk.git] / drivers / raw / ifpga / rte_pmd_ifpga.h

diff --git a/drivers/raw/ifpga/rte_pmd_ifpga.h b/drivers/raw/ifpga/rte_pmd_ifpga.h
index 633f6e9..3fa5d34 100644 (file)
--- a/drivers/raw/ifpga/rte_pmd_ifpga.h
+++ b/drivers/raw/ifpga/rte_pmd_ifpga.h
@@ -68,9 +68,6 @@ typedef struct {
 } 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 @@ typedef struct {
  *   - (-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,27 @@ rte_pmd_ifpga_get_dev_id(const char *pci_addr, uint16_t *dev_id);
  *   - (-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
+ *    The raw device ID of specified Intel FPGA device.
+ * @param stat
+ *    The RSU status value to set.
+ * @param prog
+ *    The RSU progress value to set.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENODEV) if dev_id is invalid.
+ *   - (-ENOMEM) if share data is not initialized.
+ */
+int
+rte_pmd_ifpga_set_rsu_status(uint16_t dev_id, uint32_t stat, uint32_t prog);
+
+/**
  * Get FPGA property of specified Intel FPGA device
  *
  * @param dev_id
@@ -123,14 +129,10 @@ rte_pmd_ifpga_get_rsu_status(uint16_t dev_id, uint32_t *stat, uint32_t *prog);
  *   - (-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
@@ -143,14 +145,10 @@ rte_pmd_ifpga_get_property(uint16_t dev_id, rte_pmd_ifpga_prop *prop);
  *   - (-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
@@ -166,15 +164,11 @@ rte_pmd_ifpga_get_phy_info(uint16_t dev_id, rte_pmd_ifpga_phy_info *info);
  *   - (-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
@@ -187,14 +181,10 @@ rte_pmd_ifpga_update_flash(uint16_t dev_id, const char *image,
  *   - (-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
@@ -205,14 +195,10 @@ rte_pmd_ifpga_stop_update(uint16_t dev_id, int force);
  *   - (-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
@@ -231,10 +217,42 @@ rte_pmd_ifpga_reboot_try(uint16_t dev_id);
  *   - (-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);
 
+/**
+ * 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.
+ */
+const struct rte_pci_bus *
+rte_pmd_ifpga_get_pci_bus(void);
+
+/**
+ * Perform PR (partial reconfiguration) on specified Intel FPGA device
+ *
+ * @param dev_id
+ *   The raw device ID of specified Intel FPGA device.
+ * @param port
+ *   The port index of the partial reconfiguration area.
+ * @param file
+ *   The GBS (Green BitStream) image file name string.
+ * @return
+ *   - (0) if successful.
+ *   - (-EINVAL) if bad parameter or operation failed.
+ *   - (-ENOMEM) if failed to allocate memory.
+ */
+int
+rte_pmd_ifpga_partial_reconfigure(uint16_t dev_id, int port, const char *file);
+
+/**
+ * Free software resources allocated by Intel FPGA PMD
+ */
+void
+rte_pmd_ifpga_cleanup(void);
+
 #ifdef __cplusplus
 }
 #endif