diff options
author | orivej <orivej@yandex-team.ru> | 2022-02-10 16:44:49 +0300 |
---|---|---|
committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:44:49 +0300 |
commit | 718c552901d703c502ccbefdfc3c9028d608b947 (patch) | |
tree | 46534a98bbefcd7b1f3faa5b52c138ab27db75b7 /contrib/libs/linux-headers/linux/fpga-dfl.h | |
parent | e9656aae26e0358d5378e5b63dcac5c8dbe0e4d0 (diff) | |
download | ydb-718c552901d703c502ccbefdfc3c9028d608b947.tar.gz |
Restoring authorship annotation for <orivej@yandex-team.ru>. Commit 1 of 2.
Diffstat (limited to 'contrib/libs/linux-headers/linux/fpga-dfl.h')
-rw-r--r-- | contrib/libs/linux-headers/linux/fpga-dfl.h | 394 |
1 files changed, 197 insertions, 197 deletions
diff --git a/contrib/libs/linux-headers/linux/fpga-dfl.h b/contrib/libs/linux-headers/linux/fpga-dfl.h index bdf40be990..da87b3dc54 100644 --- a/contrib/libs/linux-headers/linux/fpga-dfl.h +++ b/contrib/libs/linux-headers/linux/fpga-dfl.h @@ -1,197 +1,197 @@ -/* 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 _LINUX_FPGA_DFL_H -#define _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) - -/* 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) - -#endif /* _LINUX_FPGA_DFL_H */ +/* 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 _LINUX_FPGA_DFL_H +#define _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) + +/* 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) + +#endif /* _LINUX_FPGA_DFL_H */ |