-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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>
- Loading branch information
Alan Tull
authored and
Greg Kroah-Hartman
committed
May 25, 2018
1 parent
547b822
commit 9e4c36b
Showing
2 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,3 +9,4 @@ FPGA Subsystem | |
|
||
intro | ||
fpga-mgr | ||
fpga-bridge |