GNU Linux-libre 4.19.211-gnu1
[releases.git] / Documentation / driver-api / fpga / fpga-bridge.rst
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