3  * Driver for FPGA Device Feature List (DFL) Support
24  * when adding a new feature dev support in DFL framework, it's required to
30  * if the new feature dev needs chardev support, then it's required to add
49  * struct dfl_dev_info - dfl feature device information.
50  * @name: name string of the feature platform device.
51  * @dfh_id: id value in Device Feature Header (DFH) register by DFL spec.
52  * @id: idr id of the feature dev.
71  * struct dfl_chardev_info - chardev information of dfl feature device
135  * in such list, then other feature devices (e.g. FME), could use the port
148  * @fdata: feature dev data to match with associated port ops.
214  * @fdata: port feature dev data.
343 	    struct dfl_feature *feature)  in dfl_dev_add()  argument
372 	ddev->feature_id = feature->id;  in dfl_dev_add()
373 	ddev->revision = feature->revision;  in dfl_dev_add()
374 	ddev->dfh_version = feature->dfh_version;  in dfl_dev_add()
376 	if (feature->param_size) {  in dfl_dev_add()
377 		ddev->params = kmemdup(feature->params, feature->param_size, GFP_KERNEL);  in dfl_dev_add()
382 		ddev->param_size = feature->param_size;  in dfl_dev_add()
386 	parent_res = &pdev->resource[feature->resource_index];  in dfl_dev_add()
399 	if (feature->nr_irqs) {  in dfl_dev_add()
400 		ddev->irqs = kcalloc(feature->nr_irqs,  in dfl_dev_add()
407 		for (i = 0; i < feature->nr_irqs; i++)  in dfl_dev_add()
408 			ddev->irqs[i] = feature->irq_ctx[i].irq;  in dfl_dev_add()
410 		ddev->num_irqs = feature->nr_irqs;  in dfl_dev_add()
428 	struct dfl_feature *feature;  in dfl_devs_remove()  local
430 	dfl_fpga_dev_for_each_feature(fdata, feature) {  in dfl_devs_remove()
431 		if (feature->ddev) {  in dfl_devs_remove()
432 			device_unregister(&feature->ddev->dev);  in dfl_devs_remove()
433 			feature->ddev = NULL;  in dfl_devs_remove()
440 	struct dfl_feature *feature;  in dfl_devs_add()  local
444 	dfl_fpga_dev_for_each_feature(fdata, feature) {  in dfl_devs_add()
445 		if (feature->ioaddr)  in dfl_devs_add()
448 		if (feature->ddev) {  in dfl_devs_add()
453 		ddev = dfl_dev_add(fdata, feature);  in dfl_devs_add()
459 		feature->ddev = ddev;  in dfl_devs_add()
487 #define is_header_feature(feature) ((feature)->id == FEATURE_ID_FIU_HEADER)  argument
490  * dfl_fpga_dev_feature_uinit - uinit for sub features of dfl feature device
491  * @pdev: feature device.
496 	struct dfl_feature *feature;  in dfl_fpga_dev_feature_uinit()  local
500 	dfl_fpga_dev_for_each_feature(fdata, feature) {  in dfl_fpga_dev_feature_uinit()
501 		if (feature->ops) {  in dfl_fpga_dev_feature_uinit()
502 			if (feature->ops->uinit)  in dfl_fpga_dev_feature_uinit()
503 				feature->ops->uinit(pdev, feature);  in dfl_fpga_dev_feature_uinit()
504 			feature->ops = NULL;  in dfl_fpga_dev_feature_uinit()
511 				     struct dfl_feature *feature,  in dfl_feature_instance_init()  argument
517 	if (!is_header_feature(feature)) {  in dfl_feature_instance_init()
519 						      feature->resource_index);  in dfl_feature_instance_init()
522 				"ioremap failed for feature 0x%x!\n",  in dfl_feature_instance_init()
523 				feature->id);  in dfl_feature_instance_init()
527 		feature->ioaddr = base;  in dfl_feature_instance_init()
531 		ret = drv->ops->init(pdev, feature);  in dfl_feature_instance_init()
536 	feature->ops = drv->ops;  in dfl_feature_instance_init()
541 static bool dfl_feature_drv_match(struct dfl_feature *feature,  in dfl_feature_drv_match()  argument
548 			if (ids->id == feature->id)  in dfl_feature_drv_match()
557  * dfl_fpga_dev_feature_init - init for sub features of dfl feature device
558  * @pdev: feature device.
561  * This function will match sub features with given feature drvs list and
562  * use matched drv to init related sub feature.
571 	struct dfl_feature *feature;  in dfl_fpga_dev_feature_init()  local
575 		dfl_fpga_dev_for_each_feature(fdata, feature) {  in dfl_fpga_dev_feature_init()
576 			if (dfl_feature_drv_match(feature, drv)) {  in dfl_fpga_dev_feature_init()
577 				ret = dfl_feature_instance_init(pdev, feature, drv);  in dfl_fpga_dev_feature_init()
635  * dfl_fpga_dev_ops_register - register cdev ops for feature dev
637  * @pdev: feature dev.
638  * @fops: file operations for feature dev's cdev.
653 	 * set parent to the feature device so that its refcount is  in dfl_fpga_dev_ops_register()
655 	 * makes sure the feature device is valid during device  in dfl_fpga_dev_ops_register()
665  * dfl_fpga_dev_ops_unregister - unregister cdev ops for feature dev
666  * @pdev: feature dev.
677  * struct build_feature_devs_info - info collected during feature dev build.
680  * @cdev: the container device for all feature devices.
681  * @nr_irqs: number of irqs for all feature devices.
688  * @sub_features: a sub features linked list for feature device in enumeration.
689  * @feature_num: number of sub features for feature device in enumeration.
706  * struct dfl_feature_info - sub feature info collected during feature dev build
708  * @fid: id of this sub feature.
709  * @revision: revision of this sub feature
710  * @dfh_version: version of Device Feature Header (DFH)
711  * @mmio_res: mmio resource of this sub feature.
714  * @irq_base: start of irq index in this sub feature.
715  * @nr_irqs: number of irqs of this sub feature.
798 	/* fill features and resource information for feature dev */  in binfo_create_feature_dev_data()
800 		struct dfl_feature *feature = &fdata->features[index++];  in binfo_create_feature_dev_data()  local
804 		/* save resource information for each feature */  in binfo_create_feature_dev_data()
805 		feature->id = finfo->fid;  in binfo_create_feature_dev_data()
806 		feature->revision = finfo->revision;  in binfo_create_feature_dev_data()
807 		feature->dfh_version = finfo->dfh_version;  in binfo_create_feature_dev_data()
810 			feature->params = devm_kmemdup(binfo->dev,  in binfo_create_feature_dev_data()
813 			if (!feature->params)  in binfo_create_feature_dev_data()
816 			feature->param_size = finfo->param_size;  in binfo_create_feature_dev_data()
819 		 * the FIU header feature has some fundamental functions (sriov  in binfo_create_feature_dev_data()
822 		 * DFL bus device. And we should not assign it to feature  in binfo_create_feature_dev_data()
825 		if (is_header_feature(feature)) {  in binfo_create_feature_dev_data()
826 			feature->resource_index = -1;  in binfo_create_feature_dev_data()
827 			feature->ioaddr =  in binfo_create_feature_dev_data()
830 			if (IS_ERR(feature->ioaddr))  in binfo_create_feature_dev_data()
831 				return ERR_CAST(feature->ioaddr);  in binfo_create_feature_dev_data()
833 			feature->resource_index = res_idx;  in binfo_create_feature_dev_data()
847 			feature->irq_ctx = ctx;  in binfo_create_feature_dev_data()
848 			feature->nr_irqs = finfo->nr_irqs;  in binfo_create_feature_dev_data()
861  * register current feature device, it is called when we need to switch to
862  * another feature parsing or we have parsed all features on given device
863  * feature list.
869 	struct dfl_feature *feature;  in feature_dev_register()  local
881 	dfl_fpga_dev_for_each_feature(fdata, feature)  in feature_dev_register()
882 		feature->dev = fdev;  in feature_dev_register()
905 	dfl_fpga_dev_for_each_feature(fdata, feature)  in feature_dev_register()
906 		feature->dev = NULL;  in feature_dev_register()
913 	struct dfl_feature *feature;  in feature_dev_unregister()  local
919 	dfl_fpga_dev_for_each_feature(fdata, feature)  in feature_dev_unregister()
920 		feature->dev = NULL;  in feature_dev_unregister()
1039 		 * DFHv0 only provides MMIO resource information for each feature  in parse_feature_irqs()
1042 		 * the information in feature specific registers.  in parse_feature_irqs()
1094 	dev_dbg(binfo->dev, "feature: 0x%x, irq_base: %u, nr_irqs: %u\n",  in parse_feature_irqs()
1099 			"Invalid interrupt number in feature 0x%x\n", fid);  in parse_feature_irqs()
1107 				"Invalid irq table entry for feature 0x%x\n",  in parse_feature_irqs()
1145  * when create sub feature instances, for private features, it doesn't need
1146  * to provide resource size and feature id as they could be read from DFH
1147  * register. For afu sub feature, its register region only contains user
1167 		/* read feature size and id if inputs are invalid */  in create_feature_instance()
1343 		dev_err(binfo->dev, "the private feature 0x%x does not belong to any AFU.\n",  in parse_feature_private()
1352  * parse_feature - parse a feature on given device feature list
1354  * @binfo: build feature devices information.
1375 			 "Feature Type %x is not supported.\n", type);  in parse_feature()
1393 	/* walk through the device feature list via DFH's next DFH pointer. */  in parse_feature_list()
1396 			dev_err(binfo->dev, "The region is too small to contain a feature.\n");  in parse_feature_list()
1412 	/* commit current feature device when reach the end of list */  in parse_feature_list()
1450 	/* remove all device feature lists in the list. */  in dfl_fpga_enum_info_free()
1466  * dfl_fpga_enum_info_add_dfl - add info of a device feature list to enum info
1469  * @start: mmio resource address of the device feature list.
1470  * @len: mmio resource length of the device feature list.
1472  * One FPGA device may have one or more Device Feature Lists (DFLs), use this
1550  * dfl_fpga_feature_devs_enumerate - enumerate feature devices
1554  * feature devices based on the enumeration info and creates platform devices
1600 	 * start enumeration for all feature devices based on Device Feature  in dfl_fpga_feature_devs_enumerate()
1625  * dfl_fpga_feature_devs_remove - remove all feature devices
1628  * Remove the container device and all feature devices under given container
1868 static int do_set_irq_trigger(struct dfl_feature *feature, unsigned int idx,  in do_set_irq_trigger()  argument
1871 	struct platform_device *pdev = feature->dev;  in do_set_irq_trigger()
1875 	irq = feature->irq_ctx[idx].irq;  in do_set_irq_trigger()
1877 	if (feature->irq_ctx[idx].trigger) {  in do_set_irq_trigger()
1878 		free_irq(irq, feature->irq_ctx[idx].trigger);  in do_set_irq_trigger()
1879 		kfree(feature->irq_ctx[idx].name);  in do_set_irq_trigger()
1880 		eventfd_ctx_put(feature->irq_ctx[idx].trigger);  in do_set_irq_trigger()
1881 		feature->irq_ctx[idx].trigger = NULL;  in do_set_irq_trigger()
1887 	feature->irq_ctx[idx].name =  in do_set_irq_trigger()
1889 			  dev_name(&pdev->dev), feature->id);  in do_set_irq_trigger()
1890 	if (!feature->irq_ctx[idx].name)  in do_set_irq_trigger()
1900 			  feature->irq_ctx[idx].name, trigger);  in do_set_irq_trigger()
1902 		feature->irq_ctx[idx].trigger = trigger;  in do_set_irq_trigger()
1908 	kfree(feature->irq_ctx[idx].name);  in do_set_irq_trigger()
1914  * dfl_fpga_set_irq_triggers - set eventfd triggers for dfl feature interrupts
1916  * @feature: dfl sub feature.
1917  * @start: start of irq index in this dfl sub feature.
1922  * Bind given eventfds with irqs in this dfl sub feature. Unbind related irq if
1928 int dfl_fpga_set_irq_triggers(struct dfl_feature *feature, unsigned int start,  in dfl_fpga_set_irq_triggers()  argument
1939 	if (start + count > feature->nr_irqs)  in dfl_fpga_set_irq_triggers()
1945 		ret = do_set_irq_trigger(feature, start + i, fd);  in dfl_fpga_set_irq_triggers()
1948 				do_set_irq_trigger(feature, start + i, -1);  in dfl_fpga_set_irq_triggers()
1958  * dfl_feature_ioctl_get_num_irqs - dfl feature _GET_IRQ_NUM ioctl interface.
1959  * @pdev: the feature device which has the sub feature
1960  * @feature: the dfl sub feature
1966 				    struct dfl_feature *feature,  in dfl_feature_ioctl_get_num_irqs()  argument
1969 	return put_user(feature->nr_irqs, (__u32 __user *)arg);  in dfl_feature_ioctl_get_num_irqs()
1974  * dfl_feature_ioctl_set_irq - dfl feature _SET_IRQ ioctl interface.
1975  * @pdev: the feature device which has the sub feature
1976  * @feature: the dfl sub feature
1982 			       struct dfl_feature *feature,  in dfl_feature_ioctl_set_irq()  argument
1990 	if (!feature->nr_irqs)  in dfl_feature_ioctl_set_irq()
1996 	if (!hdr.count || (hdr.start + hdr.count > feature->nr_irqs) ||  in dfl_feature_ioctl_set_irq()
2006 	ret = dfl_fpga_set_irq_triggers(feature, hdr.start, hdr.count, fds);  in dfl_feature_ioctl_set_irq()
2024 MODULE_DESCRIPTION("FPGA Device Feature List (DFL) Support");