IGNORE THIS COMMENT: [PDDF] multifpgapci gpio module (PR #23669)

raghav-nexthop · raghav-nexthop · commit 2408a65f7703 · 2025-09-18T20:44:55.000Z
diff --git a/platform/pddf/i2c/debian/rules b/platform/pddf/i2c/debian/rules
@@ -19,7 +19,7 @@ PACKAGE_PRE_NAME := sonic-platform-pddf
 KVERSION   ?= $(shell uname -r)
 KERNEL_SRC :=  /lib/modules/$(KVERSION)
 MOD_SRC_DIR:= $(shell pwd)
-MODULE_DIRS:= client cpld cpld/driver cpldmux cpldmux/driver fpgai2c fpgai2c/driver fpgapci fpgapci/driver fpgapci/algos multifpgapci multifpgapci/driver multifpgapci/i2c fan fan/driver mux gpio led psu psu/driver sysstatus xcvr xcvr/driver
+MODULE_DIRS:= client cpld cpld/driver cpldmux cpldmux/driver fpgai2c fpgai2c/driver fpgapci fpgapci/driver fpgapci/algos multifpgapci multifpgapci/driver multifpgapci/gpio multifpgapci/gpio/driver multifpgapci/i2c fan fan/driver mux gpio led psu psu/driver sysstatus xcvr xcvr/driver
 MODULE_DIR:= modules
 UTILS_DIR := utils
 SERVICE_DIR := service
diff --git a/platform/pddf/i2c/modules/include/pddf_multifpgapci_defs.h b/platform/pddf/i2c/modules/include/pddf_multifpgapci_defs.h
@@ -21,6 +21,7 @@
 #include "linux/types.h"
 #include <linux/pci.h>
 
+#include "pddf_multifpgapci_gpio_defs.h"
 #include "pddf_multifpgapci_i2c_defs.h"
 
 #define NAME_SIZE 32
@@ -37,6 +38,10 @@ struct pddf_multifpgapci_drvdata {
 	struct kobject *i2c_kobj;
 	struct i2c_adapter_drvdata i2c_adapter_drvdata;
 	bool i2c_adapter_drvdata_initialized;
+	// gpio
+	struct kobject *gpio_kobj;
+	struct gpio_chip_drvdata gpio_chip_drvdata;
+	bool gpio_chip_drvdata_initialized;
 };
 
 // FPGA
diff --git a/platform/pddf/i2c/modules/include/pddf_multifpgapci_gpio_defs.h b/platform/pddf/i2c/modules/include/pddf_multifpgapci_gpio_defs.h
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2025 Nexthop Systems Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#ifndef __PDDF_MULTIFPGAPCI_GPIO_DEFS_H__
+#define __PDDF_MULTIFPGAPCI_GPIO_DEFS_H__
+
+#include <linux/i2c-mux.h>
+#include <linux/kobject.h>
+#include <linux/mutex.h>
+#include <linux/pci.h>
+#include <linux/sysfs.h>
+
+#include "pddf_client_defs.h"
+
+#define MAX_MULTIFPGAPCI_GPIO_LINES 64
+
+struct pddf_multifpgapci_gpio_line_pdata {
+	// Offset within FPGA
+	uint32_t offset;
+	uint32_t bit;
+	// GPIO_LINE_DIRECTION_IN = 0 or GPIO_LINE_DIRECTION_OUT = 1
+	int direction;
+};
+
+struct pddf_multifpgapci_gpio_chip_pdata {
+	// The number of GPIOs handled by this controller.
+	int ngpio;
+	struct pci_dev *fpga;
+	struct pddf_multifpgapci_gpio_line_pdata
+		chan_data[MAX_MULTIFPGAPCI_GPIO_LINES];
+};
+
+struct gpio_line_attrs {
+	PDDF_ATTR attr_bit;
+	PDDF_ATTR attr_offset;
+	PDDF_ATTR attr_direction;
+	PDDF_ATTR attr_create;
+};
+
+#define NUM_GPIO_LINE_ATTRS (sizeof(struct gpio_line_attrs) / sizeof(PDDF_ATTR))
+
+struct gpio_chip_attrs {
+	struct gpio_line_attrs line_attrs;
+	PDDF_ATTR attr_ngpio;
+	PDDF_ATTR attr_create;
+};
+
+#define NUM_GPIO_CHIP_ATTRS                                                  \
+	((sizeof(struct gpio_chip_attrs) - sizeof(struct gpio_line_attrs)) / \
+	 sizeof(PDDF_ATTR))
+
+struct gpio_chip_drvdata {
+	// pdata is passed to gpio platform driver.
+	struct pddf_multifpgapci_gpio_chip_pdata pdata;
+	// temp_line_data is mutated by sysfs attrs and copied to pdata.
+	struct pddf_multifpgapci_gpio_line_pdata temp_line_data;
+	// sysfs attrs
+	struct gpio_chip_attrs attrs;
+	struct kobject *line_kobj;
+	struct attribute *gpio_line_attrs[NUM_GPIO_LINE_ATTRS + 1];
+	struct attribute_group gpio_line_attr_group;
+	struct attribute *gpio_chip_attrs[NUM_GPIO_CHIP_ATTRS + 1];
+	struct attribute_group gpio_chip_attr_group;
+};
+
+extern int pddf_multifpgapci_gpio_module_init(struct pci_dev *pci_dev,
+					      struct kobject *kobj);
+
+// Only called if multifpgapci_gpio_module_init succeeded
+extern void pddf_multifpgapci_gpio_module_exit(struct pci_dev *pci_dev,
+					       struct kobject *kobj);
+
+#endif
diff --git a/platform/pddf/i2c/modules/multifpgapci/Makefile b/platform/pddf/i2c/modules/multifpgapci/Makefile
@@ -1,4 +1,4 @@
-obj-m := driver/ i2c/
+obj-m := driver/ gpio/ i2c/
 obj-m += pddf_multifpgapci_module.o
 
 ccflags-y:= -I$(M)/modules/include
diff --git a/platform/pddf/i2c/modules/multifpgapci/driver/pddf_multifpgapci_driver.c b/platform/pddf/i2c/modules/multifpgapci/driver/pddf_multifpgapci_driver.c
@@ -51,6 +51,7 @@
 
 #include "pddf_client_defs.h"
 #include "pddf_multifpgapci_defs.h"
+#include "pddf_multifpgapci_gpio_defs.h"
 #include "pddf_multifpgapci_i2c_defs.h"
 
 #define BDF_NAME_SIZE 32
@@ -86,6 +87,9 @@ struct pddf_attrs {
 	PDDF_ATTR attr_dev_ops;
 };
 
+#define NUM_FPGA_ATTRS \
+	(sizeof(struct pddf_attrs) / sizeof(PDDF_ATTR))
+
 struct pddf_multi_fpgapci_ops_t pddf_multi_fpgapci_ops;
 
 EXPORT_SYMBOL(pddf_multi_fpgapci_ops);
@@ -95,10 +99,16 @@ struct fpga_data_node {
 	char dev_name[DEVICE_NAME_SIZE]; // device_name as defined in pddf-device.json.
 	struct kobject *kobj;
 	struct pci_dev *dev;
-	struct pddf_attrs attrs;
 	void __iomem *fpga_ctl_addr;
 	unsigned long bar_start;
 	struct list_head list;
+
+	// sysfs attrs
+	struct pddf_attrs attrs;
+	struct attribute *fpga_attrs[NUM_FPGA_ATTRS + 1];
+	struct attribute_group fpga_attr_group;
+	bool fpga_attr_group_initialized;
+	bool pddf_clients_data_group_initialized;
 };
 
 LIST_HEAD(fpga_list);
@@ -165,12 +175,22 @@ void free_pci_drvdata(struct pci_dev *pci_dev)
 	}
 	KOBJ_FREE(pci_drvdata->i2c_kobj);
 
+	if (pci_drvdata->gpio_chip_drvdata_initialized) {
+		pddf_multifpgapci_gpio_module_exit(pci_dev,
+						   pci_drvdata->gpio_kobj);
+	}
+	KOBJ_FREE(pci_drvdata->gpio_kobj);
+
 	pci_set_drvdata(pci_dev, NULL);
 }
 
 void free_sysfs_attr_groups(struct fpga_data_node *node)
 {
-	sysfs_remove_group(node->kobj, &pddf_clients_data_group);
+	if (node->fpga_attr_group_initialized)
+		sysfs_remove_group(node->kobj, &node->fpga_attr_group);
+
+	if (node->pddf_clients_data_group_initialized)
+		sysfs_remove_group(node->kobj, &pddf_clients_data_group);
 }
 
 void delete_fpga_data_node(const char *bdf)
@@ -181,11 +201,9 @@ void delete_fpga_data_node(const char *bdf)
 
 	list_for_each_entry_safe(node, tmp, &fpga_list, list) {
 		if (strcmp(node->bdf, bdf) == 0) {
-			KOBJ_FREE(node->kobj);
-
 			free_pci_drvdata(node->dev);
 			free_sysfs_attr_groups(node);
-
+			KOBJ_FREE(node->kobj);
 			list_del(&node->list);
 			kfree(node);
 			break;
@@ -290,6 +308,23 @@ static int pddf_pci_add_fpga(char *bdf, struct pci_dev *dev)
 	}
 	pci_drvdata->i2c_adapter_drvdata_initialized = true;
 
+	pci_drvdata->gpio_kobj = kobject_create_and_add("gpio", fpga_data->kobj);
+	if (!pci_drvdata->gpio_kobj) {
+		pddf_dbg(MULTIFPGA, KERN_ERR "%s create gpio kobj failed\n",
+			 __FUNCTION__);
+		ret = -ENOMEM;
+		goto free_i2c_dirs;
+	}
+
+	ret = pddf_multifpgapci_gpio_module_init(dev, pci_drvdata->gpio_kobj);
+	if (ret) {
+		pddf_dbg(MULTIFPGA,
+			 KERN_ERR "%s create add gpio module failed %d\n",
+			 __FUNCTION__, ret);
+		goto free_gpio_kobj;
+	}
+	pci_drvdata->gpio_chip_drvdata_initialized = true;
+
 	fpga_data->dev = dev;
 
 	PDDF_DATA_ATTR(
@@ -298,40 +333,50 @@ static int pddf_pci_add_fpga(char *bdf, struct pci_dev *dev)
 
 	fpga_data->attrs.attr_dev_ops = attr_dev_ops;
 
-	struct attribute *attrs_fpgapci[] = {
-		&fpga_data->attrs.attr_dev_ops.dev_attr.attr,
-		NULL,
-	};
+	fpga_data->fpga_attrs[0] = &fpga_data->attrs.attr_dev_ops.dev_attr.attr;
+	fpga_data->fpga_attrs[1] = NULL;
 
-	struct attribute_group attr_group_fpgapci = {
-		.attrs = attrs_fpgapci,
-	};
-
-	mutex_lock(&fpga_list_lock);
-	list_add(&fpga_data->list, &fpga_list);
-	mutex_unlock(&fpga_list_lock);
+	fpga_data->fpga_attr_group.attrs = fpga_data->fpga_attrs;
 
-	ret = sysfs_create_group(fpga_data->kobj, &attr_group_fpgapci);
+	ret = sysfs_create_group(fpga_data->kobj, &fpga_data->fpga_attr_group);
 
 	if (ret) {
 		pddf_dbg(MULTIFPGA,
 			 KERN_ERR "%s create fpga sysfs attributes failed\n",
 			 __FUNCTION__);
-		return ret;
+		goto free_gpio_dirs;
 	}
+	fpga_data->fpga_attr_group_initialized = true;
 
 	ret = sysfs_create_group(fpga_data->kobj, &pddf_clients_data_group);
 	if (ret) {
 		pddf_dbg(MULTIFPGA,
-			 KERN_ERR "[%s] sysfs_create_group failed: %d\n",
+			 KERN_ERR "[%s] create pddf_clients_data_group failed: %d\n",
 			 __FUNCTION__, ret);
 		goto free_fpga_attr_group;
 	}
+	fpga_data->pddf_clients_data_group_initialized = true;
+
+	mutex_lock(&fpga_list_lock);
+	list_add(&fpga_data->list, &fpga_list);
+	mutex_unlock(&fpga_list_lock);
 
 	return 0;
 
 free_fpga_attr_group:
-	sysfs_remove_group(fpga_data->kobj, &attr_group_fpgapci);
+	fpga_data->fpga_attr_group_initialized = false;
+	sysfs_remove_group(fpga_data->kobj, &fpga_data->fpga_attr_group);
+
+free_gpio_dirs:
+	pci_drvdata->gpio_chip_drvdata_initialized = false;
+	pddf_multifpgapci_gpio_module_exit(dev, pci_drvdata->gpio_kobj);
+
+free_gpio_kobj:
+	kobject_put(pci_drvdata->gpio_kobj);
+
+free_i2c_dirs:
+	pci_drvdata->i2c_adapter_drvdata_initialized = false;
+	pddf_multifpgapci_i2c_module_exit(dev, pci_drvdata->i2c_kobj);
 
 free_i2c_kobj:
 	kobject_put(pci_drvdata->i2c_kobj);
@@ -571,7 +616,7 @@ static int pddf_multifpgapci_probe(struct pci_dev *dev,
 			 KERN_ERR
 			 "[%s] pci_enable_device failed. dev:%s err:%#x\n",
 			 __FUNCTION__, pci_name(dev), err);
-		return err;
+		goto error_enable_dev;
 	}
 
 	// Enable DMA
@@ -595,6 +640,7 @@ static int pddf_multifpgapci_probe(struct pci_dev *dev,
 			 KERN_ERR
 			 "[%s] couldn't allocate pci_privdata memory\n",
 			 __FUNCTION__);
+		err = -ENOMEM;
 		goto error_pci_req;
 	}
 
@@ -605,10 +651,10 @@ static int pddf_multifpgapci_probe(struct pci_dev *dev,
 
 	return 0;
 
-// ERROR HANDLING
 error_pci_req:
 	pci_disable_device(dev);
-	return -ENODEV;
+error_enable_dev:
+	return err;
 }
 
 // Initialize the driver module (but not any device) and register
diff --git a/platform/pddf/i2c/modules/multifpgapci/gpio/Makefile b/platform/pddf/i2c/modules/multifpgapci/gpio/Makefile
@@ -0,0 +1,6 @@
+obj-m := driver/
+
+TARGET = pddf_multifpgapci_gpio_module
+obj-m += $(TARGET).o
+
+ccflags-y := -I$(M)/modules/include
diff --git a/platform/pddf/i2c/modules/multifpgapci/gpio/driver/Makefile b/platform/pddf/i2c/modules/multifpgapci/gpio/driver/Makefile
@@ -0,0 +1,4 @@
+TARGET = pddf_multifpgapci_gpio_driver_module
+obj-m := pddf_multifpgapci_gpio_driver.o
+
+ccflags-y := -I$(M)/modules/include
diff --git a/platform/pddf/i2c/modules/multifpgapci/gpio/driver/pddf_multifpgapci_gpio_driver.c b/platform/pddf/i2c/modules/multifpgapci/gpio/driver/pddf_multifpgapci_gpio_driver.c
diff --git a/platform/pddf/i2c/modules/multifpgapci/gpio/pddf_multifpgapci_gpio_module.c b/platform/pddf/i2c/modules/multifpgapci/gpio/pddf_multifpgapci_gpio_module.c
diff --git a/platform/pddf/i2c/utils/pddfparse.py b/platform/pddf/i2c/utils/pddfparse.py
