driver-api/fpga/fpga-region.rst

1 FPGA Region
7 This document is meant to be a brief overview of the FPGA region API usage.  A
11 For the purposes of this API document, let's just say that a region associates
12 an FPGA Manager and a bridge (or bridges) with a reprogrammable region of an
13 FPGA or the whole FPGA.  The API provides a way to register a region and to
14 program a region.
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
18 to program the FPGA and then DT to handle enumeration.  The common region code
22 An fpga-region can be set up to know the following things:
37 How to add a new FPGA region
42 .. [#f1] ../devicetree/bindings/fpga/fpga-region.txt
43 .. [#f2] ../../drivers/fpga/of-fpga-region.c
45 API to add a new FPGA region
48 * struct fpga_region - The FPGA region struct
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
57 automatically set the module that registers the FPGA region as the owner.
59 The FPGA region's probe function will need to get a reference to the FPGA
61 during the region's probe function.
68 The FPGA region will need to specify which bridges to control while programming
69 the FPGA.  The region driver can build a list of bridges during probe time
81 .. kernel-doc:: include/linux/fpga/fpga-region.h
84 .. kernel-doc:: include/linux/fpga/fpga-region.h
87 .. kernel-doc:: drivers/fpga/fpga-region.c
90 .. kernel-doc:: drivers/fpga/fpga-region.c
93 .. kernel-doc:: drivers/fpga/fpga-region.c