[PATCH V0 1/3] drivers/misc/amd: Add new driver amd versal-pci
From: Yidong Zhang
Date: Sun Mar 02 2025 - 23:44:23 EST
AMD Versal based PCIe card, including V70 and RAVE, is designed for AI
inference efficiency and is tuned for video analytics and natural language
processing applications.
The driver architecture:
+---------+----+ Remote +-----+------+
| |PCIe| Queue | Embedded |
| Mgmt PF |Bar | <=======> | SoC |
| | | +------------+
+---------+----+ | base FW |
+-----+------+
This driver provides the following functionalities:
- module and PCI device initialization
the driver will initialize itself based on bar resources for a
hardware queue based ring buffer between PCIe bar and RTOS services
VMR [1] running on Embedded SoC hardware firmware for flashing
firmware and checking card healthy status.
- programming FW
The base FW is downloaded onto the flash of the card.
[1] https://github.com/Xilinx/VMR.git
Co-developed-by: DMG Karthik <Karthik.DMG@xxxxxxx>
Signed-off-by: DMG Karthik <Karthik.DMG@xxxxxxx>
Co-developed-by: Nishad Saraf <nishads@xxxxxxx>
Signed-off-by: Nishad Saraf <nishads@xxxxxxx>
Signed-off-by: Yidong Zhang <yidong.zhang@xxxxxxx>
---
MAINTAINERS | 5 +
drivers/misc/Kconfig | 1 +
drivers/misc/Makefile | 1 +
drivers/misc/amd/Kconfig | 15 ++
drivers/misc/amd/Makefile | 5 +
drivers/misc/amd/versal-pci-main.c | 272 +++++++++++++++++++++++++++++
drivers/misc/amd/versal-pci.h | 62 +++++++
7 files changed, 361 insertions(+)
create mode 100644 drivers/misc/amd/Kconfig
create mode 100644 drivers/misc/amd/Makefile
create mode 100644 drivers/misc/amd/versal-pci-main.c
create mode 100644 drivers/misc/amd/versal-pci.h
diff --git a/MAINTAINERS b/MAINTAINERS
index 8e0736dc2ee0..8d79e8b7e963 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1215,6 +1215,11 @@ L: linux-spi@xxxxxxxxxxxxxxx
S: Supported
F: drivers/spi/spi-amd.c
+AMD VERSAL PCI DRIVER
+M: Yidong Zhang <yidong.zhang@xxxxxxx>
+S: Supported
+F: drivers/misc/amd/
+
AMD XDNA DRIVER
M: Min Ma <min.ma@xxxxxxx>
M: Lizhi Hou <lizhi.hou@xxxxxxx>
diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig
index 56bc72c7ce4a..d1616f0fb12f 100644
--- a/drivers/misc/Kconfig
+++ b/drivers/misc/Kconfig
@@ -649,4 +649,5 @@ source "drivers/misc/uacce/Kconfig"
source "drivers/misc/pvpanic/Kconfig"
source "drivers/misc/mchp_pci1xxxx/Kconfig"
source "drivers/misc/keba/Kconfig"
+source "drivers/misc/amd/Kconfig"
endmenu
diff --git a/drivers/misc/Makefile b/drivers/misc/Makefile
index 545aad06d088..230a8d6bafaf 100644
--- a/drivers/misc/Makefile
+++ b/drivers/misc/Makefile
@@ -75,3 +75,4 @@ lan966x-pci-objs := lan966x_pci.o
lan966x-pci-objs += lan966x_pci.dtbo.o
obj-$(CONFIG_MCHP_LAN966X_PCI) += lan966x-pci.o
obj-y += keba/
+obj-$(CONFIG_AMD_VERSAL_PCI) += amd/
diff --git a/drivers/misc/amd/Kconfig b/drivers/misc/amd/Kconfig
new file mode 100644
index 000000000000..8b1a9bd0d150
--- /dev/null
+++ b/drivers/misc/amd/Kconfig
@@ -0,0 +1,15 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+config AMD_VERSAL_PCI
+ tristate "AMD Versal PCIe Management Driver"
+ select FW_LOADER
+ select CONFIGFS_FS
+ depends on HAS_IOMEM
+ depends on PCI
+ default m
+ help
+ AMD Versal PCIe Management Driver provides management services,
+ including download firmware, program bitstream, and communicate with
+ the User function.
+
+ If "M" is selected, the driver module will be versal-pci
diff --git a/drivers/misc/amd/Makefile b/drivers/misc/amd/Makefile
new file mode 100644
index 000000000000..e3868cb39563
--- /dev/null
+++ b/drivers/misc/amd/Makefile
@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: GPL-2.0+
+
+obj-$(CONFIG_AMD_VERSAL_PCI) += versal-pci.o
+
+versal-pci-$(CONFIG_AMD_VERSAL_PCI) := versal-pci-main.o
diff --git a/drivers/misc/amd/versal-pci-main.c b/drivers/misc/amd/versal-pci-main.c
new file mode 100644
index 000000000000..1c61c88120b4
--- /dev/null
+++ b/drivers/misc/amd/versal-pci-main.c
@@ -0,0 +1,272 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Driver for Versal PCIe device
+ *
+ * Copyright (C) 2025 Advanced Micro Devices, Inc. All rights reserved.
+ */
+
+#include <linux/pci.h>
+
+#include "versal-pci.h"
+
+#define DRV_NAME "amd-versal-pci"
+
+#define PCI_DEVICE_ID_V70PQ2 0x50B0
+#define PCI_DEVICE_ID_RAVE 0x5700
+#define VERSAL_XCLBIN_MAGIC_ID "xclbin2"
+
+static inline u32 versal_pci_devid(struct versal_pci_device *vdev)
+{
+ return ((pci_domain_nr(vdev->pdev->bus) << 16) |
+ PCI_DEVID(vdev->pdev->bus->number, vdev->pdev->devfn));
+}
+
+static int versal_pci_load_shell(struct versal_pci_device *vdev, char *fw_name)
+{
+ const struct firmware *fw;
+ struct axlf *xsabin;
+ int ret;
+
+ strim(fw_name);
+
+ ret = request_firmware(&fw, fw_name, &vdev->pdev->dev);
+ if (ret) {
+ vdev_warn(vdev, "request xsabin fw %s failed %d", fw_name, ret);
+ return ret;
+ }
+
+ xsabin = (struct axlf *)fw->data;
+ if (memcmp(xsabin->magic, VERSAL_XCLBIN_MAGIC_ID, sizeof(VERSAL_XCLBIN_MAGIC_ID))) {
+ vdev_err(vdev, "Invalid device firmware");
+ ret = -EINVAL;
+ goto release_firmware;
+ }
+
+ if (!fw->size ||
+ fw->size != xsabin->header.length ||
+ fw->size < sizeof(*xsabin) ||
+ fw->size > SZ_1G) {
+ vdev_err(vdev, "Invalid device firmware size %zu", fw->size);
+ ret = -EINVAL;
+ goto release_firmware;
+ }
+
+ if (!uuid_equal(&vdev->intf_uuid, &xsabin->header.rom_uuid)) {
+ vdev_err(vdev, "base shell doesn't match uuid %pUb", &xsabin->header.uuid);
+ ret = -EINVAL;
+ goto release_firmware;
+ }
+
+ /* TODO upload fw to card */
+ if (ret) {
+ vdev_err(vdev, "failed to load xsabin %s : %d", fw_name, ret);
+ goto release_firmware;
+ }
+
+ vdev_info(vdev, "Downloaded xsabin %pUb of size %lld Bytes",
+ &xsabin->header.uuid, xsabin->header.length);
+
+release_firmware:
+ release_firmware(fw);
+
+ return ret;
+}
+
+static inline struct versal_pci_device *item_to_vdev(struct config_item *item)
+{
+ return container_of(to_configfs_subsystem(to_config_group(item)),
+ struct versal_pci_device, cfs_subsys);
+}
+
+static ssize_t versal_pci_cfs_config_store(struct config_item *item,
+ const char *page, size_t count)
+{
+ struct versal_pci_device *vdev = item_to_vdev(item);
+ u32 config;
+ int ret;
+
+ ret = kstrtou32(page, 0, &config);
+ if (ret)
+ return -EINVAL;
+
+ if (config)
+ ret = versal_pci_load_shell(vdev, vdev->fw.name);
+
+ if (ret)
+ return -EFAULT;
+
+ return count;
+}
+CONFIGFS_ATTR_WO(versal_pci_cfs_, config);
+
+static ssize_t versal_pci_cfs_image_show(struct config_item *item, char *page)
+{
+ struct versal_pci_device *vdev = item_to_vdev(item);
+
+ vdev_info(vdev, "fw name: %s", vdev->fw.name);
+
+ return 0;
+}
+
+static ssize_t versal_pci_cfs_image_store(struct config_item *item,
+ const char *page, size_t count)
+{
+ struct versal_pci_device *vdev = item_to_vdev(item);
+
+ count = snprintf(vdev->fw.name, sizeof(vdev->fw.name), "%s", page);
+
+ vdev_info(vdev, "fw name: %s", vdev->fw.name);
+ return count;
+}
+CONFIGFS_ATTR(versal_pci_cfs_, image);
+
+static struct configfs_attribute *versal_pci_cfs_attrs[] = {
+ &versal_pci_cfs_attr_config,
+ &versal_pci_cfs_attr_image,
+ NULL,
+};
+
+static const struct config_item_type versal_pci_cfs_table = {
+ .ct_owner = THIS_MODULE,
+ .ct_attrs = versal_pci_cfs_attrs,
+};
+
+static int versal_pci_cfs_init(struct versal_pci_device *vdev)
+{
+ struct configfs_subsystem *subsys = &vdev->cfs_subsys;
+
+ snprintf(subsys->su_group.cg_item.ci_namebuf,
+ sizeof(subsys->su_group.cg_item.ci_namebuf),
+ "%s%x", DRV_NAME, versal_pci_devid(vdev));
+
+ subsys->su_group.cg_item.ci_type = &versal_pci_cfs_table;
+
+ config_group_init(&subsys->su_group);
+ return configfs_register_subsystem(subsys);
+}
+
+static void versal_pci_fw_fini(struct versal_pci_device *vdev)
+{
+ uuid_copy(&vdev->intf_uuid, &uuid_null);
+}
+
+static void versal_pci_cfs_fini(struct configfs_subsystem *subsys)
+{
+ configfs_unregister_subsystem(subsys);
+}
+
+static void versal_pci_device_teardown(struct versal_pci_device *vdev)
+{
+ versal_pci_cfs_fini(&vdev->cfs_subsys);
+ versal_pci_fw_fini(vdev);
+}
+
+static void versal_pci_uuid_parse(struct versal_pci_device *vdev, uuid_t *uuid)
+{
+ char str[UUID_STRING_LEN];
+ u8 i, j;
+ int len = strlen(vdev->fw_id);
+
+ /* parse uuid into a valid uuid string format */
+ for (i = 0, j = 0; i < len && i < sizeof(str); i++) {
+ str[j++] = vdev->fw_id[i];
+ if (j == 8 || j == 13 || j == 18 || j == 23)
+ str[j++] = '-';
+ }
+
+ uuid_parse(str, uuid);
+ vdev_info(vdev, "Interface uuid %pU", uuid);
+}
+
+static int versal_pci_fw_init(struct versal_pci_device *vdev)
+{
+ /* TODO request compatible fw_id from card */
+
+ versal_pci_uuid_parse(vdev, &vdev->intf_uuid);
+
+ return 0;
+}
+
+static int versal_pci_device_setup(struct versal_pci_device *vdev)
+{
+ int ret;
+
+ ret = versal_pci_fw_init(vdev);
+ if (ret) {
+ vdev_err(vdev, "Failed to init fw, err %d", ret);
+ goto comm_chan_fini;
+ }
+
+ ret = versal_pci_cfs_init(vdev);
+ if (ret) {
+ vdev_err(vdev, "Failed to init configfs subsys, err %d", ret);
+ goto comm_chan_fini;
+ }
+
+ return 0;
+
+comm_chan_fini:
+
+ return ret;
+}
+
+static void versal_pci_remove(struct pci_dev *pdev)
+{
+ struct versal_pci_device *vdev = pci_get_drvdata(pdev);
+
+ versal_pci_device_teardown(vdev);
+}
+
+static int versal_pci_probe(struct pci_dev *pdev, const struct pci_device_id *pdev_id)
+{
+ struct versal_pci_device *vdev;
+ int ret;
+
+ vdev = devm_kzalloc(&pdev->dev, sizeof(*vdev), GFP_KERNEL);
+ if (!vdev)
+ return -ENOMEM;
+
+ pci_set_drvdata(pdev, vdev);
+ vdev->pdev = pdev;
+
+ ret = pcim_enable_device(pdev);
+ if (ret) {
+ vdev_err(vdev, "Failed to enable device %d", ret);
+ return ret;
+ }
+
+ vdev->io_regs = pcim_iomap_region(vdev->pdev, MGMT_BAR, DRV_NAME);
+ if (IS_ERR(vdev->io_regs)) {
+ vdev_err(vdev, "Failed to map RM shared memory BAR%d", MGMT_BAR);
+ return PTR_ERR(vdev->io_regs);
+ }
+
+ ret = versal_pci_device_setup(vdev);
+ if (ret) {
+ vdev_err(vdev, "Failed to setup Versal device %d", ret);
+ return ret;
+ }
+
+ return 0;
+}
+
+static const struct pci_device_id versal_pci_ids[] = {
+ { PCI_DEVICE(PCI_VENDOR_ID_XILINX, PCI_DEVICE_ID_V70PQ2), },
+ { PCI_DEVICE(PCI_VENDOR_ID_XILINX, PCI_DEVICE_ID_RAVE), },
+ { 0 }
+};
+
+MODULE_DEVICE_TABLE(pci, versal_pci_ids);
+
+static struct pci_driver versal_pci_driver = {
+ .name = DRV_NAME,
+ .id_table = versal_pci_ids,
+ .probe = versal_pci_probe,
+ .remove = versal_pci_remove,
+};
+
+module_pci_driver(versal_pci_driver);
+
+MODULE_DESCRIPTION("AMD Versal PCIe Management Driver");
+MODULE_AUTHOR("XRT Team <runtimeca39d@xxxxxxx>");
+MODULE_LICENSE("GPL");
diff --git a/drivers/misc/amd/versal-pci.h b/drivers/misc/amd/versal-pci.h
new file mode 100644
index 000000000000..ca309aee87ad
--- /dev/null
+++ b/drivers/misc/amd/versal-pci.h
@@ -0,0 +1,62 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Driver for Versal PCIe device
+ *
+ * Copyright (C) 2025 Advanced Micro Devices, Inc. All rights reserved.
+ */
+
+#ifndef __VERSAL_PCI_H
+#define __VERSAL_PCI_H
+
+#include <linux/configfs.h>
+#include <linux/firmware.h>
+
+#define MGMT_BAR 0
+
+#define vdev_info(vdev, fmt, args...) \
+ dev_info(&(vdev)->pdev->dev, "%s: "fmt, __func__, ##args)
+
+#define vdev_warn(vdev, fmt, args...) \
+ dev_warn(&(vdev)->pdev->dev, "%s: "fmt, __func__, ##args)
+
+#define vdev_err(vdev, fmt, args...) \
+ dev_err(&(vdev)->pdev->dev, "%s: "fmt, __func__, ##args)
+
+#define vdev_dbg(vdev, fmt, args...) \
+ dev_dbg(&(vdev)->pdev->dev, fmt, ##args)
+
+struct versal_pci_device;
+
+struct axlf_header {
+ __u64 length;
+ __u8 reserved1[24];
+ uuid_t rom_uuid;
+ __u8 reserved2[64];
+ uuid_t uuid;
+ __u8 reserved3[24];
+} __packed;
+
+struct axlf {
+ __u8 magic[8];
+ __u8 reserved[296];
+ struct axlf_header header;
+} __packed;
+
+struct fw_info {
+ __u32 opcode;
+ char name[128];
+};
+
+struct versal_pci_device {
+ struct pci_dev *pdev;
+
+ struct fw_info fw;
+
+ void __iomem *io_regs;
+ uuid_t intf_uuid;
+ __u8 fw_id[UUID_STRING_LEN + 1];
+
+ struct configfs_subsystem cfs_subsys;
+};
+
+#endif /* __VERSAL_PCI_H */
--
2.34.1