driver-api/fpga/fpga-region.rst

5 --------
8 more conceptual look at regions can be found in the Device Tree binding
16 Currently the only layer above fpga-region.c in the kernel is the Device Tree
17 support (of-fpga-region.c) described in [#f1]_.  The DT support layer uses regions
22 An fpga-region can be set up to know the following things:
28 Additional info needed to program the FPGA image is passed in the struct
31  * pointers to the image as either a scatter-gather buffer, a contiguous
38 ----------------------------
40 An example of usage can be seen in the probe function of [#f2]_.
42 .. [#f1] ../devicetree/bindings/fpga/fpga-region.txt
43 .. [#f2] ../../drivers/fpga/of-fpga-region.c
46 ----------------------------
48 * struct fpga_region - The FPGA region struct
49 * struct fpga_region_info - Parameter structure for __fpga_region_register_full()
50 * __fpga_region_register_full() -  Create and register an FPGA region using the
52 * __fpga_region_register() -  Create and register an FPGA region using standard
54 * fpga_region_unregister() -  Unregister an FPGA region
63 * fpga_mgr_get() - Get a reference to an FPGA manager, raise ref count
64 * of_fpga_mgr_get() -  Get a reference to an FPGA manager, raise ref count,
66 * fpga_mgr_put() - Put an FPGA manager
70 (:c:expr:`fpga_region->bridge_list`) or it can have a function that creates
72 (:c:expr:`fpga_region->get_bridges`).  The FPGA bridge framework supplies the
75 * fpga_bridge_get_to_list() - Get a ref of an FPGA bridge, add it to a
77 * of_fpga_bridge_get_to_list() - Get a ref of an FPGA bridge, add it to a
79 * fpga_bridges_put() - Given a list of bridges, put them
81 .. kernel-doc:: include/linux/fpga/fpga-region.h
82    :functions: fpga_region
84 .. kernel-doc:: include/linux/fpga/fpga-region.h
85    :functions: fpga_region_info
87 .. kernel-doc:: drivers/fpga/fpga-region.c
88    :functions: __fpga_region_register_full
90 .. kernel-doc:: drivers/fpga/fpga-region.c
91    :functions: __fpga_region_register
93 .. kernel-doc:: drivers/fpga/fpga-region.c
94    :functions: fpga_region_unregister
96 .. kernel-doc:: drivers/fpga/fpga-mgr.c
97    :functions: fpga_mgr_get
99 .. kernel-doc:: drivers/fpga/fpga-mgr.c
100    :functions: of_fpga_mgr_get
102 .. kernel-doc:: drivers/fpga/fpga-mgr.c
103    :functions: fpga_mgr_put
105 .. kernel-doc:: drivers/fpga/fpga-bridge.c
106    :functions: fpga_bridge_get_to_list
108 .. kernel-doc:: drivers/fpga/fpga-bridge.c
109    :functions: of_fpga_bridge_get_to_list
111 .. kernel-doc:: drivers/fpga/fpga-bridge.c
112    :functions: fpga_bridges_put