mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-28 20:02:17 +00:00
09d8615014
AFU (Accelerated Function Unit) is dynamic region of the DFL based FPGA, and always defined by users. Some DFL based FPGA cards allow users to implement their own interrupts in AFU. In order to support this, hardware implements a new UINT (AFU Interrupt) private feature with related capability register which describes the number of supported AFU interrupts as well as the local index of the interrupts for software enumeration, and from software side, driver follows the common DFL interrupt notification and handling mechanism, and it implements two ioctls below for user to query number of irqs supported and set/unset interrupt triggers. Ioctls: * DFL_FPGA_PORT_UINT_GET_IRQ_NUM get the number of irqs, which is used to determine how many interrupts UINT feature supports. * DFL_FPGA_PORT_UINT_SET_IRQ set/unset eventfds as AFU interrupt triggers. Signed-off-by: Luwei Kang <luwei.kang@intel.com> Signed-off-by: Wu Hao <hao.wu@intel.com> Signed-off-by: Xu Yilun <yilun.xu@intel.com> Reviewed-by: Marcelo Tosatti <mtosatti@redhat.com> Acked-by: Wu Hao <hao.wu@intel.com> Signed-off-by: Moritz Fischer <mdf@kernel.org>
279 lines
8.5 KiB
C
279 lines
8.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
|
|
/*
|
|
* Header File for FPGA DFL User API
|
|
*
|
|
* Copyright (C) 2017-2018 Intel Corporation, Inc.
|
|
*
|
|
* Authors:
|
|
* Kang Luwei <luwei.kang@intel.com>
|
|
* Zhang Yi <yi.z.zhang@intel.com>
|
|
* Wu Hao <hao.wu@intel.com>
|
|
* Xiao Guangrong <guangrong.xiao@linux.intel.com>
|
|
*/
|
|
|
|
#ifndef _UAPI_LINUX_FPGA_DFL_H
|
|
#define _UAPI_LINUX_FPGA_DFL_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/ioctl.h>
|
|
|
|
#define DFL_FPGA_API_VERSION 0
|
|
|
|
/*
|
|
* The IOCTL interface for DFL based FPGA is designed for extensibility by
|
|
* embedding the structure length (argsz) and flags into structures passed
|
|
* between kernel and userspace. This design referenced the VFIO IOCTL
|
|
* interface (include/uapi/linux/vfio.h).
|
|
*/
|
|
|
|
#define DFL_FPGA_MAGIC 0xB6
|
|
|
|
#define DFL_FPGA_BASE 0
|
|
#define DFL_PORT_BASE 0x40
|
|
#define DFL_FME_BASE 0x80
|
|
|
|
/* Common IOCTLs for both FME and AFU file descriptor */
|
|
|
|
/**
|
|
* DFL_FPGA_GET_API_VERSION - _IO(DFL_FPGA_MAGIC, DFL_FPGA_BASE + 0)
|
|
*
|
|
* Report the version of the driver API.
|
|
* Return: Driver API Version.
|
|
*/
|
|
|
|
#define DFL_FPGA_GET_API_VERSION _IO(DFL_FPGA_MAGIC, DFL_FPGA_BASE + 0)
|
|
|
|
/**
|
|
* DFL_FPGA_CHECK_EXTENSION - _IO(DFL_FPGA_MAGIC, DFL_FPGA_BASE + 1)
|
|
*
|
|
* Check whether an extension is supported.
|
|
* Return: 0 if not supported, otherwise the extension is supported.
|
|
*/
|
|
|
|
#define DFL_FPGA_CHECK_EXTENSION _IO(DFL_FPGA_MAGIC, DFL_FPGA_BASE + 1)
|
|
|
|
/* IOCTLs for AFU file descriptor */
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_RESET - _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 0)
|
|
*
|
|
* Reset the FPGA Port and its AFU. No parameters are supported.
|
|
* Userspace can do Port reset at any time, e.g. during DMA or PR. But
|
|
* it should never cause any system level issue, only functional failure
|
|
* (e.g. DMA or PR operation failure) and be recoverable from the failure.
|
|
* Return: 0 on success, -errno of failure
|
|
*/
|
|
|
|
#define DFL_FPGA_PORT_RESET _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 0)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_GET_INFO - _IOR(DFL_FPGA_MAGIC, DFL_PORT_BASE + 1,
|
|
* struct dfl_fpga_port_info)
|
|
*
|
|
* Retrieve information about the fpga port.
|
|
* Driver fills the info in provided struct dfl_fpga_port_info.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
struct dfl_fpga_port_info {
|
|
/* Input */
|
|
__u32 argsz; /* Structure length */
|
|
/* Output */
|
|
__u32 flags; /* Zero for now */
|
|
__u32 num_regions; /* The number of supported regions */
|
|
__u32 num_umsgs; /* The number of allocated umsgs */
|
|
};
|
|
|
|
#define DFL_FPGA_PORT_GET_INFO _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 1)
|
|
|
|
/**
|
|
* FPGA_PORT_GET_REGION_INFO - _IOWR(FPGA_MAGIC, PORT_BASE + 2,
|
|
* struct dfl_fpga_port_region_info)
|
|
*
|
|
* Retrieve information about a device memory region.
|
|
* Caller provides struct dfl_fpga_port_region_info with index value set.
|
|
* Driver returns the region info in other fields.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
struct dfl_fpga_port_region_info {
|
|
/* input */
|
|
__u32 argsz; /* Structure length */
|
|
/* Output */
|
|
__u32 flags; /* Access permission */
|
|
#define DFL_PORT_REGION_READ (1 << 0) /* Region is readable */
|
|
#define DFL_PORT_REGION_WRITE (1 << 1) /* Region is writable */
|
|
#define DFL_PORT_REGION_MMAP (1 << 2) /* Can be mmaped to userspace */
|
|
/* Input */
|
|
__u32 index; /* Region index */
|
|
#define DFL_PORT_REGION_INDEX_AFU 0 /* AFU */
|
|
#define DFL_PORT_REGION_INDEX_STP 1 /* Signal Tap */
|
|
__u32 padding;
|
|
/* Output */
|
|
__u64 size; /* Region size (bytes) */
|
|
__u64 offset; /* Region offset from start of device fd */
|
|
};
|
|
|
|
#define DFL_FPGA_PORT_GET_REGION_INFO _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 2)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_DMA_MAP - _IOWR(DFL_FPGA_MAGIC, DFL_PORT_BASE + 3,
|
|
* struct dfl_fpga_port_dma_map)
|
|
*
|
|
* Map the dma memory per user_addr and length which are provided by caller.
|
|
* Driver fills the iova in provided struct afu_port_dma_map.
|
|
* This interface only accepts page-size aligned user memory for dma mapping.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
struct dfl_fpga_port_dma_map {
|
|
/* Input */
|
|
__u32 argsz; /* Structure length */
|
|
__u32 flags; /* Zero for now */
|
|
__u64 user_addr; /* Process virtual address */
|
|
__u64 length; /* Length of mapping (bytes)*/
|
|
/* Output */
|
|
__u64 iova; /* IO virtual address */
|
|
};
|
|
|
|
#define DFL_FPGA_PORT_DMA_MAP _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 3)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_DMA_UNMAP - _IOW(FPGA_MAGIC, PORT_BASE + 4,
|
|
* struct dfl_fpga_port_dma_unmap)
|
|
*
|
|
* Unmap the dma memory per iova provided by caller.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
struct dfl_fpga_port_dma_unmap {
|
|
/* Input */
|
|
__u32 argsz; /* Structure length */
|
|
__u32 flags; /* Zero for now */
|
|
__u64 iova; /* IO virtual address */
|
|
};
|
|
|
|
#define DFL_FPGA_PORT_DMA_UNMAP _IO(DFL_FPGA_MAGIC, DFL_PORT_BASE + 4)
|
|
|
|
/**
|
|
* struct dfl_fpga_irq_set - the argument for DFL_FPGA_XXX_SET_IRQ ioctl.
|
|
*
|
|
* @start: Index of the first irq.
|
|
* @count: The number of eventfd handler.
|
|
* @evtfds: Eventfd handlers.
|
|
*/
|
|
struct dfl_fpga_irq_set {
|
|
__u32 start;
|
|
__u32 count;
|
|
__s32 evtfds[];
|
|
};
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_ERR_GET_IRQ_NUM - _IOR(DFL_FPGA_MAGIC, DFL_PORT_BASE + 5,
|
|
* __u32 num_irqs)
|
|
*
|
|
* Get the number of irqs supported by the fpga port error reporting private
|
|
* feature. Currently hardware supports up to 1 irq.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_PORT_ERR_GET_IRQ_NUM _IOR(DFL_FPGA_MAGIC, \
|
|
DFL_PORT_BASE + 5, __u32)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_ERR_SET_IRQ - _IOW(DFL_FPGA_MAGIC, DFL_PORT_BASE + 6,
|
|
* struct dfl_fpga_irq_set)
|
|
*
|
|
* Set fpga port error reporting interrupt trigger if evtfds[n] is valid.
|
|
* Unset related interrupt trigger if evtfds[n] is a negative value.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_PORT_ERR_SET_IRQ _IOW(DFL_FPGA_MAGIC, \
|
|
DFL_PORT_BASE + 6, \
|
|
struct dfl_fpga_irq_set)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_UINT_GET_IRQ_NUM - _IOR(DFL_FPGA_MAGIC, DFL_PORT_BASE + 7,
|
|
* __u32 num_irqs)
|
|
*
|
|
* Get the number of irqs supported by the fpga AFU interrupt private
|
|
* feature.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_PORT_UINT_GET_IRQ_NUM _IOR(DFL_FPGA_MAGIC, \
|
|
DFL_PORT_BASE + 7, __u32)
|
|
|
|
/**
|
|
* DFL_FPGA_PORT_UINT_SET_IRQ - _IOW(DFL_FPGA_MAGIC, DFL_PORT_BASE + 8,
|
|
* struct dfl_fpga_irq_set)
|
|
*
|
|
* Set fpga AFU interrupt trigger if evtfds[n] is valid.
|
|
* Unset related interrupt trigger if evtfds[n] is a negative value.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_PORT_UINT_SET_IRQ _IOW(DFL_FPGA_MAGIC, \
|
|
DFL_PORT_BASE + 8, \
|
|
struct dfl_fpga_irq_set)
|
|
|
|
/* IOCTLs for FME file descriptor */
|
|
|
|
/**
|
|
* DFL_FPGA_FME_PORT_PR - _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 0,
|
|
* struct dfl_fpga_fme_port_pr)
|
|
*
|
|
* Driver does Partial Reconfiguration based on Port ID and Buffer (Image)
|
|
* provided by caller.
|
|
* Return: 0 on success, -errno on failure.
|
|
* If DFL_FPGA_FME_PORT_PR returns -EIO, that indicates the HW has detected
|
|
* some errors during PR, under this case, the user can fetch HW error info
|
|
* from the status of FME's fpga manager.
|
|
*/
|
|
|
|
struct dfl_fpga_fme_port_pr {
|
|
/* Input */
|
|
__u32 argsz; /* Structure length */
|
|
__u32 flags; /* Zero for now */
|
|
__u32 port_id;
|
|
__u32 buffer_size;
|
|
__u64 buffer_address; /* Userspace address to the buffer for PR */
|
|
};
|
|
|
|
#define DFL_FPGA_FME_PORT_PR _IO(DFL_FPGA_MAGIC, DFL_FME_BASE + 0)
|
|
|
|
/**
|
|
* DFL_FPGA_FME_PORT_RELEASE - _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 1,
|
|
* int port_id)
|
|
*
|
|
* Driver releases the port per Port ID provided by caller.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_FME_PORT_RELEASE _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 1, int)
|
|
|
|
/**
|
|
* DFL_FPGA_FME_PORT_ASSIGN - _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 2,
|
|
* int port_id)
|
|
*
|
|
* Driver assigns the port back per Port ID provided by caller.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_FME_PORT_ASSIGN _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 2, int)
|
|
|
|
/**
|
|
* DFL_FPGA_FME_ERR_GET_IRQ_NUM - _IOR(DFL_FPGA_MAGIC, DFL_FME_BASE + 3,
|
|
* __u32 num_irqs)
|
|
*
|
|
* Get the number of irqs supported by the fpga fme error reporting private
|
|
* feature. Currently hardware supports up to 1 irq.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_FME_ERR_GET_IRQ_NUM _IOR(DFL_FPGA_MAGIC, \
|
|
DFL_FME_BASE + 3, __u32)
|
|
|
|
/**
|
|
* DFL_FPGA_FME_ERR_SET_IRQ - _IOW(DFL_FPGA_MAGIC, DFL_FME_BASE + 4,
|
|
* struct dfl_fpga_irq_set)
|
|
*
|
|
* Set fpga fme error reporting interrupt trigger if evtfds[n] is valid.
|
|
* Unset related interrupt trigger if evtfds[n] is a negative value.
|
|
* Return: 0 on success, -errno on failure.
|
|
*/
|
|
#define DFL_FPGA_FME_ERR_SET_IRQ _IOW(DFL_FPGA_MAGIC, \
|
|
DFL_FME_BASE + 4, \
|
|
struct dfl_fpga_irq_set)
|
|
|
|
#endif /* _UAPI_LINUX_FPGA_DFL_H */
|