Skip to content

Commit 9e4c36b

Browse files
atull-alteragregkh
authored andcommitted
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 <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent 547b822 commit 9e4c36b

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
FPGA Bridge
2+
===========
3+
4+
API to implement a new FPGA bridge
5+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6+
7+
.. kernel-doc:: include/linux/fpga/fpga-bridge.h
8+
:functions: fpga_bridge
9+
10+
.. kernel-doc:: include/linux/fpga/fpga-bridge.h
11+
:functions: fpga_bridge_ops
12+
13+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
14+
:functions: fpga_bridge_create
15+
16+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
17+
:functions: fpga_bridge_free
18+
19+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
20+
:functions: fpga_bridge_register
21+
22+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
23+
:functions: fpga_bridge_unregister
24+
25+
API to control an FPGA bridge
26+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27+
28+
You probably won't need these directly. FPGA regions should handle this.
29+
30+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
31+
:functions: of_fpga_bridge_get
32+
33+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
34+
:functions: fpga_bridge_get
35+
36+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
37+
:functions: fpga_bridge_put
38+
39+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
40+
:functions: fpga_bridge_get_to_list
41+
42+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
43+
:functions: of_fpga_bridge_get_to_list
44+
45+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
46+
:functions: fpga_bridge_enable
47+
48+
.. kernel-doc:: drivers/fpga/fpga-bridge.c
49+
:functions: fpga_bridge_disable

Documentation/driver-api/fpga/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ FPGA Subsystem
99

1010
intro
1111
fpga-mgr
12+
fpga-bridge

0 commit comments

Comments
 (0)