Commit a4c1aaf9 authored by Greg Kroah-Hartman's avatar Greg Kroah-Hartman
Browse files

Merge tag 'fpga-for-5.17-rc1' of... 

Merge tag 'fpga-for-5.17-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/mdf/linux-fpga

 into char-misc-next

Moritz writes:

FPGA Manager changes for 5.17-rc1

Russ' patches rework the way we register FPGA managers, regions and
bridges by simplifying the functions into a single register call.

Nathan's patch addresses an unused variable warning that was introduced
by Russ' patches.

Yang's patch addresses a kernel doc warning.

All patches have been reviewed on the mailing list, and have been in the
last few linux-next releases (as part of our for-next branch) without issues.

Signed-off-by: default avatarMoritz Fischer <mdf@kernel.org>

* tag 'fpga-for-5.17-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/mdf/linux-fpga:
  fpga: region: fix kernel-doc
  fpga: stratix10-soc: Do not use ret uninitialized in s10_probe()
  fpga: region: Use standard dev_release for class driver
  fpga: bridge: Use standard dev_release for class driver
  fpga: mgr: Use standard dev_release for class driver
parents 1b18af40 98ceca2f

Documentation/driver-api/fpga/fpga-bridge.rst

+1 −5
Original line number Diff line number Diff line
@@ -6,8 +6,7 @@ API to implement a new FPGA bridge 


* struct fpga_bridge - The FPGA Bridge structure

* struct fpga_bridge_ops - Low level Bridge driver ops

* devm_fpga_bridge_create() - Allocate and init a bridge struct

* fpga_bridge_register() - Register a bridge

* fpga_bridge_register() - Create and register a bridge

* fpga_bridge_unregister() - Unregister a bridge



.. kernel-doc:: include/linux/fpga/fpga-bridge.h
@@ -16,9 +15,6 @@ API to implement a new FPGA bridge 
.. kernel-doc:: include/linux/fpga/fpga-bridge.h

   :functions: fpga_bridge_ops



.. kernel-doc:: drivers/fpga/fpga-bridge.c

   :functions: devm_fpga_bridge_create



.. kernel-doc:: drivers/fpga/fpga-bridge.c

   :functions: fpga_bridge_register

Documentation/driver-api/fpga/fpga-mgr.rst

+29 −9
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ How to support a new FPGA device 
--------------------------------



To add another FPGA manager, write a driver that implements a set of ops.  The

probe function calls fpga_mgr_register(), such as::

probe function calls fpga_mgr_register() or fpga_mgr_register_full(), such as::



	static const struct fpga_manager_ops socfpga_fpga_ops = {

		.write_init = socfpga_fpga_ops_configure_init,
@@ -49,14 +49,14 @@ probe function calls fpga_mgr_register(), such as:: 
		 * them in priv

		 */



		mgr = devm_fpga_mgr_create(dev, "Altera SOCFPGA FPGA Manager",

		mgr = fpga_mgr_register(dev, "Altera SOCFPGA FPGA Manager",

					&socfpga_fpga_ops, priv);

		if (!mgr)

			return -ENOMEM;

		if (IS_ERR(mgr))

			return PTR_ERR(mgr);



		platform_set_drvdata(pdev, mgr);



		return fpga_mgr_register(mgr);

		return 0;

	}



	static int socfpga_fpga_remove(struct platform_device *pdev)
@@ -68,6 +68,11 @@ probe function calls fpga_mgr_register(), such as:: 
		return 0;

	}



Alternatively, the probe function could call one of the resource managed

register functions, devm_fpga_mgr_register() or devm_fpga_mgr_register_full().

When these functions are used, the parameter syntax is the same, but the call

to fpga_mgr_unregister() should be removed. In the above example, the

socfpga_fpga_remove() function would not be required.



The ops will implement whatever device specific register writes are needed to

do the programming sequence for this particular FPGA.  These ops return 0 for
@@ -104,8 +109,14 @@ API for implementing a new FPGA Manager driver 
* ``fpga_mgr_states`` -  Values for :c:expr:`fpga_manager->state`.

* struct fpga_manager -  the FPGA manager struct

* struct fpga_manager_ops -  Low level FPGA manager driver ops

* devm_fpga_mgr_create() -  Allocate and init a manager struct

* fpga_mgr_register() -  Register an FPGA manager

* struct fpga_manager_info -  Parameter structure for fpga_mgr_register_full()

* fpga_mgr_register_full() -  Create and register an FPGA manager using the

  fpga_mgr_info structure to provide the full flexibility of options

* fpga_mgr_register() -  Create and register an FPGA manager using standard

  arguments

* devm_fpga_mgr_register_full() -  Resource managed version of

  fpga_mgr_register_full()

* devm_fpga_mgr_register() -  Resource managed version of fpga_mgr_register()

* fpga_mgr_unregister() -  Unregister an FPGA manager



.. kernel-doc:: include/linux/fpga/fpga-mgr.h
@@ -117,11 +128,20 @@ API for implementing a new FPGA Manager driver 
.. kernel-doc:: include/linux/fpga/fpga-mgr.h

   :functions: fpga_manager_ops



.. kernel-doc:: include/linux/fpga/fpga-mgr.h

   :functions: fpga_manager_info



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: devm_fpga_mgr_create

   :functions: fpga_mgr_register_full



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: fpga_mgr_register



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: devm_fpga_mgr_register_full



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: devm_fpga_mgr_register



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: fpga_mgr_unregister

Documentation/driver-api/fpga/fpga-region.rst

+9 −3
Original line number Diff line number Diff line
@@ -46,8 +46,11 @@ API to add a new FPGA region 
----------------------------



* struct fpga_region - The FPGA region struct

* devm_fpga_region_create() - Allocate and init a region struct

* fpga_region_register() -  Register an FPGA region

* struct fpga_region_info - Parameter structure for fpga_region_register_full()

* fpga_region_register_full() -  Create and register an FPGA region using the

  fpga_region_info structure to provide the full flexibility of options

* fpga_region_register() -  Create and register an FPGA region using standard

  arguments

* fpga_region_unregister() -  Unregister an FPGA region



The FPGA region's probe function will need to get a reference to the FPGA
@@ -75,8 +78,11 @@ following APIs to handle building or tearing down that list. 
.. kernel-doc:: include/linux/fpga/fpga-region.h

   :functions: fpga_region



.. kernel-doc:: include/linux/fpga/fpga-region.h

   :functions: fpga_region_info



.. kernel-doc:: drivers/fpga/fpga-region.c

   :functions: devm_fpga_region_create

   :functions: fpga_region_register_full



.. kernel-doc:: drivers/fpga/fpga-region.c

   :functions: fpga_region_register

drivers/fpga/altera-cvp.c

+4 −8
Original line number Diff line number Diff line
@@ -652,19 +652,15 @@ static int altera_cvp_probe(struct pci_dev *pdev, 
	snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",

		 ALTERA_CVP_MGR_NAME, pci_name(pdev));



	mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,

	mgr = fpga_mgr_register(&pdev->dev, conf->mgr_name,

				&altera_cvp_ops, conf);

	if (!mgr) {

		ret = -ENOMEM;

	if (IS_ERR(mgr)) {

		ret = PTR_ERR(mgr);

		goto err_unmap;

	}



	pci_set_drvdata(pdev, mgr);



	ret = fpga_mgr_register(mgr);

	if (ret)

		goto err_unmap;



	return 0;



err_unmap:

drivers/fpga/altera-fpga2sdram.c

+4 −8
Original line number Diff line number Diff line
@@ -121,17 +121,13 @@ static int alt_fpga_bridge_probe(struct platform_device *pdev) 
	/* Get f2s bridge configuration saved in handoff register */

	regmap_read(sysmgr, SYSMGR_ISWGRP_HANDOFF3, &priv->mask);



	br = devm_fpga_bridge_create(dev, F2S_BRIDGE_NAME,

	br = fpga_bridge_register(dev, F2S_BRIDGE_NAME,

				  &altera_fpga2sdram_br_ops, priv);

	if (!br)

		return -ENOMEM;

	if (IS_ERR(br))

		return PTR_ERR(br);



	platform_set_drvdata(pdev, br);



	ret = fpga_bridge_register(br);

	if (ret)

		return ret;



	dev_info(dev, "driver initialized with handoff %08x\n", priv->mask);



	if (!of_property_read_u32(dev->of_node, "bridge-enable", &enable)) {