d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
e0ae50c687
numam-dpdk/drivers/raw/ifpga/rte_pmd_ifpga.h
Wei Huang f724a8025d raw/ifpga: add miscellaneous APIs 
Below miscellaneous APIs are used to implement OPAE application.
1. rte_pmd_ifpga_get_pci_bus() get PCI bus ifpga driver registered.
2. rte_pmd_ifpga_partial_reconfigure() do partial reconfiguration.
3. rte_pmd_ifpga_cleanup() free software resources allocated by driver.
4. rte_pmd_ifpga_set_rsu_status() set status of rsu process.

Signed-off-by: Wei Huang <wei.huang@intel.com>
Acked-by: Tianfei Zhang <tianfei.zhang@intel.com>
Acked-by: Rosen Xu <rosen.xu@intel.com>
2021-03-05 09:56:18 +01:00

309 lines
7.5 KiB
C
Raw Blame History

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2021 Intel Corporation
*/
#ifndef _RTE_PMD_IFPGA_H_
#define _RTE_PMD_IFPGA_H_
/**
* @file rte_pmd_ifpga.h
*
* ifpga PMD specific functions.
*
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#define IFPGA_MAX_PORT_NUM 4
/**
* UUID data structure.
*/
typedef struct {
uint8_t b[16];
} rte_pmd_ifpga_uuid;
/**
* FME property data structure.
*/
typedef struct {
uint32_t num_ports;
uint32_t boot_page;
uint64_t bitstream_id;
uint64_t bitstream_metadata;
rte_pmd_ifpga_uuid pr_id;
uint32_t bmc_version;
uint32_t bmc_nios_version;
} rte_pmd_ifpga_common_prop;
/**
* port property data structure.
*/
typedef struct {
rte_pmd_ifpga_uuid afu_id;
uint32_t type; /* AFU memory access control type */
} rte_pmd_ifpga_port_prop;
/**
* FPGA property data structure.
*/
typedef struct {
rte_pmd_ifpga_common_prop common;
rte_pmd_ifpga_port_prop port[IFPGA_MAX_PORT_NUM];
} rte_pmd_ifpga_prop;
/**
* PHY information data structure.
*/
typedef struct {
uint32_t num_retimers;
uint32_t link_speed;
uint32_t link_status;
} 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
* The PCI address of specified Intel FPGA device.
* @param dev_id
* The buffer to output device ID.
* @return
* - (0) if successful.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @param stat
* The buffer to output RSU status.
* @param prog
* The buffer to output RSU progress.
* @return
* - (0) if successful.
* - (-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.
*/
__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
* The raw device ID of specified Intel FPGA device.
* @param prop
* The data pointer of FPGA property buffer.
* @return
* - (0) if successful.
* - (-ENODEV) if dev_id is invalid.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @param info
* The data pointer of PHY information buffer.
* @return
* - (0) if successful.
* - (-ENODEV) if dev_id is invalid.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @param image
* The image file name string.
* @param status
* The detailed update status for debug.
* @return
* - (0) if successful.
* - (-ENODEV) if dev_id is invalid.
* - (-EINVAL) if bad parameter or staging area is not initialized.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @param force
* Abort the update process by writing register if set non-zero.
* @return
* - (0) if successful.
* - (-ENODEV) if dev_id is invalid.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @return
* - (0) if FPGA is ready to reboot.
* - (-ENODEV) if dev_id is invalid.
* - (-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
* The raw device ID of specified Intel FPGA device.
* @param type
* Select reconfiguration type.
* 0 - reconfigure FPGA only.
* 1 - reboot the whole card including FPGA.
* @param page
* Select image from which flash partition.
* 0 - factory partition.
* 1 - user partition.
* @return
* - (0) if successful.
* - (-ENODEV) if dev_id is invalid.
* - (-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
* 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.
*/
__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);
#ifdef __cplusplus
}
#endif
#endif /* _RTE_PMD_IFPGA_H_ */
Reference in New Issue View Git Blame Copy Permalink