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

FPGA Bridge
===========

API to implement a new FPGA bridge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* struct fpga_bridge - The FPGA Bridge structure
* struct fpga_bridge_ops - Low level Bridge driver ops
* fpga_bridge_register() - Create and register a bridge
* fpga_bridge_unregister() - Unregister a bridge

.. kernel-doc:: include/linux/fpga/fpga-bridge.h
   :functions: fpga_bridge

.. kernel-doc:: include/linux/fpga/fpga-bridge.h
   :functions: fpga_bridge_ops

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

.. kernel-doc:: drivers/fpga/fpga-bridge.c
   :functions: fpga_bridge_unregister
documentation: fpga: add bridge document to driver-api Add a new document to driver-api/fpga that documents the fpga bridge API and add it to driver-api/fpga/index.rst Signed-off-by: Alan Tull <atull@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2018-05-16 18:50:04 -05:00			`FPGA Bridge`
			`===========`

			`API to implement a new FPGA bridge`
			`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`

docs: driver-api: fpga: avoid using UTF-8 chars While UTF-8 characters can be used at the Linux documentation, the best is to use them only when ASCII doesn't offer a good replacement. So, replace the occurences of the following UTF-8 characters: - U+2014 ('—'): EM DASH Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Moritz Fischer <mdf@kernel.org> 2021-05-10 12:26:25 +02:00			`* struct fpga_bridge - The FPGA Bridge structure`
			`* struct fpga_bridge_ops - Low level Bridge driver ops`
fpga: bridge: Use standard dev_release for class driver The FPGA bridge class driver data structure is being treated as a managed resource instead of using the standard dev_release call-back function to release the class data structure. This change removes the managed resource code and combines the create() and register() functions into a single register() function. Signed-off-by: Russ Weight <russell.h.weight@intel.com> Reviewed-by: Xu Yilun <yilun.xu@intel.com> Acked-by: Xu Yilun <yilun.xu@intel.com> Signed-off-by: Moritz Fischer <mdf@kernel.org> 2021-11-18 17:55:52 -08:00			`* fpga_bridge_register() - Create and register a bridge`
docs: driver-api: fpga: avoid using UTF-8 chars While UTF-8 characters can be used at the Linux documentation, the best is to use them only when ASCII doesn't offer a good replacement. So, replace the occurences of the following UTF-8 characters: - U+2014 ('—'): EM DASH Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Moritz Fischer <mdf@kernel.org> 2021-05-10 12:26:25 +02:00			`* fpga_bridge_unregister() - Unregister a bridge`
docs: fpga: document programming fpgas using regions Clarify the intention that interfaces and upper layers use regions rather than managers directly. Rearrange API documentation to better group the API functions used to create FPGA mgr/bridge/regions and the API used for programming FPGAs. Signed-off-by: Alan Tull <atull@kernel.org> Suggested-by: Federico Vaga <federico.vaga@cern.ch> Acked-by: Moritz Fischer <mdf@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2018-10-15 17:20:04 -05:00
documentation: fpga: add bridge document to driver-api Add a new document to driver-api/fpga that documents the fpga bridge API and add it to driver-api/fpga/index.rst Signed-off-by: Alan Tull <atull@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2018-05-16 18:50:04 -05:00			`.. kernel-doc:: include/linux/fpga/fpga-bridge.h`
			`:functions: fpga_bridge`

			`.. kernel-doc:: include/linux/fpga/fpga-bridge.h`
			`:functions: fpga_bridge_ops`

			`.. kernel-doc:: drivers/fpga/fpga-bridge.c`
			`:functions: fpga_bridge_register`

			`.. kernel-doc:: drivers/fpga/fpga-bridge.c`
			`:functions: fpga_bridge_unregister`