| From 44b0f3d942d78ede17c67ab306e100c52cdf2fca Mon Sep 17 00:00:00 2001 |
| From: Alan Tull <atull@kernel.org> |
| Date: Wed, 16 May 2018 18:50:04 -0500 |
| Subject: [PATCH 1697/1795] 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> |
| (cherry picked from commit 9e4c36b1c9799de406a183c0fe946a614d97288c) |
| Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> |
| --- |
| Documentation/driver-api/fpga/fpga-bridge.rst | 49 +++++++++++++++++++ |
| Documentation/driver-api/fpga/index.rst | 1 + |
| 2 files changed, 50 insertions(+) |
| create mode 100644 Documentation/driver-api/fpga/fpga-bridge.rst |
| |
| diff --git a/Documentation/driver-api/fpga/fpga-bridge.rst b/Documentation/driver-api/fpga/fpga-bridge.rst |
| new file mode 100644 |
| index 000000000000..2c2aaca894bf |
| --- /dev/null |
| +++ b/Documentation/driver-api/fpga/fpga-bridge.rst |
| @@ -0,0 +1,49 @@ |
| +FPGA Bridge |
| +=========== |
| + |
| +API to implement a new FPGA 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_create |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_free |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_register |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_unregister |
| + |
| +API to control an FPGA bridge |
| +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| + |
| +You probably won't need these directly. FPGA regions should handle this. |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: of_fpga_bridge_get |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_get |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_put |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_get_to_list |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: of_fpga_bridge_get_to_list |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_enable |
| + |
| +.. kernel-doc:: drivers/fpga/fpga-bridge.c |
| + :functions: fpga_bridge_disable |
| diff --git a/Documentation/driver-api/fpga/index.rst b/Documentation/driver-api/fpga/index.rst |
| index 34b20754517f..968bbbfce0e8 100644 |
| --- a/Documentation/driver-api/fpga/index.rst |
| +++ b/Documentation/driver-api/fpga/index.rst |
| @@ -9,3 +9,4 @@ FPGA Subsystem |
| |
| intro |
| fpga-mgr |
| + fpga-bridge |
| -- |
| 2.19.0 |
| |