Merge pull request #5 from houlz0507/v5

V5 add xrt_bus_type

Author: houlz0507

Documentation/fpga/xrt.rst

@@ -6916,7 +6916,7 @@ M:	Lizhi Hou <lizhi.hou@xilinx.com>
 R:	Max Zhen <max.zhen@xilinx.com>
 R:	Sonal Santan <sonal.santan@xilinx.com>
 L:	linux-fpga@vger.kernel.org
-S:	Maintained
+S:	Supported
 W:	https://github.com/Xilinx/XRT
 F:	Documentation/fpga/xrt.rst
 F:	drivers/fpga/xrt/

MAINTAINERS

@@ -13,7 +13,7 @@
 #include <linux/vmalloc.h>
 #include <linux/uuid.h>
 
-#define XRT_MD_INVALID_LENGTH (~0UL)
+#define XRT_MD_INVALID_LENGTH (~0U)
 
 /* metadata properties */
 #define XRT_MD_PROP_BAR_IDX "pcie_bar_mapping"
@@ -38,6 +38,7 @@
  * AF:  AXI Firewall
  * CMC: Card Management Controller
  * ERT: Embedded Runtime
+ * EP:  End Point
  * PLP: Provider Reconfigurable Partition
  * ULP: User Reconfigurable Partition
  */
@@ -47,11 +48,11 @@
 #define XRT_MD_NODE_AF_CTRL_DEBUG "ep_firewall_ctrl_debug_00"
 #define XRT_MD_NODE_AF_CTRL_MGMT "ep_firewall_ctrl_mgmt_00"
 #define XRT_MD_NODE_AF_CTRL_USER "ep_firewall_ctrl_user_00"
-#define XRT_MD_NODE_AF_DATA_C2H "ep_firewall_data_c2h_00"
-#define XRT_MD_NODE_AF_DATA_H2C "ep_firewall_data_h2c_00"
+#define XRT_MD_NODE_AF_DATA_C2H "ep_firewall_data_c2h_00" /* c2h: card to host */
+#define XRT_MD_NODE_AF_DATA_H2C "ep_firewall_data_h2c_00" /* h2c: host to card */
 #define XRT_MD_NODE_AF_DATA_M2M "ep_firewall_data_m2m_00"
 #define XRT_MD_NODE_AF_DATA_P2P "ep_firewall_data_p2p_00"
-#define XRT_MD_NODE_CLKFREQ_HBM "ep_freq_cnt_aclk_hbm_00"
+#define XRT_MD_NODE_CLKFREQ_HBM "ep_freq_cnt_aclk_hbm_00" /* hbm: High Bandwidth Memory */
 #define XRT_MD_NODE_CLKFREQ_K1 "ep_freq_cnt_aclk_kernel_00"
 #define XRT_MD_NODE_CLKFREQ_K2 "ep_freq_cnt_aclk_kernel_01"
 #define XRT_MD_NODE_CLK_KERNEL1 "ep_aclk_kernel_00"
@@ -95,9 +96,9 @@
 #define XRT_MD_NODE_XVC_PRI "ep_debug_bscan_mgmt_00"
 #define XRT_MD_NODE_UCS_CONTROL_STATUS "ep_ucs_control_status_00"
 
-/* endpoint regmaps */
-#define XRT_MD_REGMAP_DDR_SRSR "drv_ddr_srsr"
-#define XRT_MD_REGMAP_CLKFREQ "freq_cnt"
+/* endpoint compatible string */
+#define XRT_MD_COMPAT_DDR_SRSR "drv_ddr_srsr"
+#define XRT_MD_COMPAT_CLKFREQ "freq_cnt"
 
 /* driver defined endpoints */
 #define XRT_MD_NODE_BLP_ROM "drv_ep_blp_rom_00"
@@ -123,11 +124,11 @@
 
 struct xrt_md_endpoint {
 	const char	*ep_name;
-	u32		bar;
+	u32		bar_index;
 	u64		bar_off;
-	ulong		size;
-	char		*regmap;
-	char		*regmap_ver;
+	u64		size;
+	char		*compat;
+	char		*compat_ver;
 };
 
 /* Note: res_id is defined by leaf driver and must start with 0. */
@@ -162,29 +163,29 @@ xrt_md_res_id2name(const struct xrt_iores_map *res_map, int entry_num, int id)
 	return NULL;
 }
 
-unsigned long xrt_md_size(struct device *dev, const char *blob);
+u32 xrt_md_size(struct device *dev, const char *blob);
 int xrt_md_create(struct device *dev, char **blob);
 char *xrt_md_dup(struct device *dev, const char *blob);
 int xrt_md_add_endpoint(struct device *dev, char *blob,
 			struct xrt_md_endpoint *ep);
 int xrt_md_del_endpoint(struct device *dev, char *blob, const char *ep_name,
-			const char *regmap_name);
+			const char *compat);
 int xrt_md_get_prop(struct device *dev, const char *blob, const char *ep_name,
-		    const char *regmap_name, const char *prop,
+		    const char *compat, const char *prop,
 		    const void **val, int *size);
 int xrt_md_set_prop(struct device *dev, char *blob, const char *ep_name,
-		    const char *regmap_name, const char *prop,
+		    const char *compat, const char *prop,
 		    const void *val, int size);
 int xrt_md_copy_endpoint(struct device *dev, char *blob, const char *src_blob,
-			 const char *ep_name, const char *regmap_name,
+			 const char *ep_name, const char *compat,
 			 const char *new_ep_name);
 int xrt_md_get_next_endpoint(struct device *dev, const char *blob,
-			     const char *ep_name,  const char *regmap_name,
-			     char **next_ep, char **next_regmap);
+			     const char *ep_name,  const char *compat,
+			     char **next_ep, char **next_compat);
 int xrt_md_get_compatible_endpoint(struct device *dev, const char *blob,
-				   const char *regmap_name, const char **ep_name);
+				   const char *compat, const char **ep_name);
 int xrt_md_find_endpoint(struct device *dev, const char *blob,
-			 const char *ep_name, const char *regmap_name,
+			 const char *ep_name, const char *compat,
 			 const char **epname);
 int xrt_md_pack(struct device *dev, char *blob);
 int xrt_md_get_interface_uuids(struct device *dev, const char *blob,
@@ -214,7 +215,9 @@ static inline int xrt_md_trans_str2uuid(struct device *dev, const char *uuidstr,
 	char tmp[3] = { 0 };
 	int i, ret;
 
-	BUILD_BUG_ON(UUID_SIZE != 16);
+	if (strlen(uuidstr) != UUID_SIZE * 2)
+		return -EINVAL;
+
 	str = uuidstr + strlen(uuidstr) - 2;
 
 	for (i = 0; i < sizeof(*p_uuid) && str >= uuidstr; i++) {

drivers/fpga/xrt/include/metadata.h

@@ -15,23 +15,24 @@
  * of a specific instance of a subdev driver.
  */
 enum xrt_subdev_id {
-	XRT_SUBDEV_GRP = 0,
-	XRT_SUBDEV_VSEC = 1,
-	XRT_SUBDEV_VSEC_GOLDEN = 2,
-	XRT_SUBDEV_DEVCTL = 3,
-	XRT_SUBDEV_AXIGATE = 4,
-	XRT_SUBDEV_ICAP = 5,
-	XRT_SUBDEV_TEST = 6,
-	XRT_SUBDEV_MGMT_MAIN = 7,
-	XRT_SUBDEV_QSPI = 8,
-	XRT_SUBDEV_MAILBOX = 9,
-	XRT_SUBDEV_CMC = 10,
-	XRT_SUBDEV_CALIB = 11,
-	XRT_SUBDEV_CLKFREQ = 12,
-	XRT_SUBDEV_CLOCK = 13,
-	XRT_SUBDEV_SRSR = 14,
-	XRT_SUBDEV_UCS = 15,
-	XRT_SUBDEV_NUM = 16, /* Total number of subdevs. */
+	XRT_SUBDEV_INVALID = 0,
+	XRT_SUBDEV_GRP,
+	XRT_SUBDEV_VSEC,
+	XRT_SUBDEV_VSEC_GOLDEN,
+	XRT_SUBDEV_DEVCTL,
+	XRT_SUBDEV_AXIGATE,
+	XRT_SUBDEV_ICAP,
+	XRT_SUBDEV_TEST,
+	XRT_SUBDEV_MGMT_MAIN,
+	XRT_SUBDEV_QSPI,
+	XRT_SUBDEV_MAILBOX,
+	XRT_SUBDEV_CMC,
+	XRT_SUBDEV_CALIB,
+	XRT_SUBDEV_CLKFREQ,
+	XRT_SUBDEV_CLOCK,
+	XRT_SUBDEV_SRSR,
+	XRT_SUBDEV_UCS,
+	XRT_SUBDEV_NUM, /* Total number of subdevs. */
 	XRT_ROOT = -1, /* Special ID for root driver. */
 };
 

drivers/fpga/xrt/include/subdev_id.h

@@ -16,7 +16,7 @@
 
 #define XCLBIN_VERSION2	"xclbin2"
 #define XCLBIN_HWICAP_BITFILE_BUF_SZ 1024
-#define XCLBIN_MAX_SIZE (1024 * 1024 * 1024) /* Assuming xclbin <= 1G, always */
+#define XCLBIN_MAX_SZ_1G (1024 * 1024 * 1024) /* Assuming xclbin <= 1G, always */
 
 enum axlf_section_kind;
 struct axlf;

drivers/fpga/xrt/include/xclbin-helper.h

@@ -0,0 +1,131 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Copyright (C) 2020-2021 Xilinx, Inc.
+ *
+ * Authors:
+ *    Lizhi Hou <lizhi.hou@xilinx.com>
+ */
+
+#ifndef _XRT_DEVICE_H_
+#define _XRT_DEVICE_H_
+
+#include <linux/fs.h>
+#include <linux/cdev.h>
+
+#define XRT_MAX_DEVICE_NODES		128
+#define XRT_INVALID_DEVICE_INST		(XRT_MAX_DEVICE_NODES + 1)
+
+enum {
+	XRT_DEVICE_STATE_NONE = 0,
+	XRT_DEVICE_STATE_ADDED
+};
+
+/*
+ * struct xrt_device - represent an xrt device on xrt bus
+ *
+ * dev: generic device interface.
+ * id: id of the xrt device.
+ */
+struct xrt_device {
+	struct device dev;
+	u32 subdev_id;
+	const char *name;
+	u32 instance;
+	u32 state;
+	u32 num_resources;
+	struct resource *resource;
+	void *sdev_data;
+};
+
+/*
+ * If populated by xrt device driver, infra will handle the mechanics of
+ * char device (un)registration.
+ */
+enum xrt_dev_file_mode {
+	/* Infra create cdev, default file name */
+	XRT_DEV_FILE_DEFAULT = 0,
+	/* Infra create cdev, need to encode inst num in file name */
+	XRT_DEV_FILE_MULTI_INST,
+	/* No auto creation of cdev by infra, leaf handles it by itself */
+	XRT_DEV_FILE_NO_AUTO,
+};
+
+struct xrt_dev_file_ops {
+	const struct file_operations xsf_ops;
+	dev_t xsf_dev_t;
+	const char *xsf_dev_name;
+	enum xrt_dev_file_mode xsf_mode;
+};
+
+/*
+ * this struct define the endpoints belong to the same xrt device
+ */
+struct xrt_dev_ep_names {
+	const char *ep_name;
+	const char *compat;
+};
+
+struct xrt_dev_endpoints {
+	struct xrt_dev_ep_names *xse_names;
+	/* minimum number of endpoints to support the subdevice */
+	u32 xse_min_ep;
+};
+
+/*
+ * struct xrt_driver - represent a xrt device driver
+ *
+ * drv: driver model structure.
+ * id_table: pointer to table of device IDs the driver is interested in.
+ *           { } member terminated.
+ * probe: mandatory callback for device binding.
+ * remove: callback for device unbinding.
+ */
+struct xrt_driver {
+	struct device_driver driver;
+	u32 subdev_id;
+	struct xrt_dev_file_ops file_ops;
+	struct xrt_dev_endpoints *endpoints;
+
+	/*
+	 * Subdev driver callbacks populated by subdev driver.
+	 */
+	int (*probe)(struct xrt_device *xrt_dev);
+	void (*remove)(struct xrt_device *xrt_dev);
+	/*
+	 * If leaf_call is defined, these are called by other leaf drivers.
+	 * Note that root driver may call into leaf_call of a group driver.
+	 */
+	int (*leaf_call)(struct xrt_device *xrt_dev, u32 cmd, void *arg);
+};
+
+#define to_xrt_dev(d) container_of(d, struct xrt_device, dev)
+#define to_xrt_drv(d) container_of(d, struct xrt_driver, driver)
+
+static inline void *xrt_get_drvdata(const struct xrt_device *xdev)
+{
+	return dev_get_drvdata(&xdev->dev);
+}
+
+static inline void xrt_set_drvdata(struct xrt_device *xdev, void *data)
+{
+	dev_set_drvdata(&xdev->dev, data);
+}
+
+static inline void *xrt_get_xdev_data(struct device *dev)
+{
+	struct xrt_device *xdev = to_xrt_dev(dev);
+
+	return xdev->sdev_data;
+}
+
+struct xrt_device *
+xrt_device_register(struct device *parent, u32 id,
+		    struct resource *res, u32 res_num,
+		    void *pdata, size_t data_sz);
+void xrt_device_unregister(struct xrt_device *xdev);
+int xrt_register_driver(struct xrt_driver *drv);
+void xrt_unregister_driver(struct xrt_driver *drv);
+void *xrt_get_xdev_data(struct device *dev);
+struct resource *xrt_get_resource(struct xrt_device *xdev, u32 type, u32 num);
+
+#endif /* _XRT_DEVICE_H_ */