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
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
18 to program the FPGA and then DT to handle enumeration.  The common region code
24  * which FPGA manager to use to do the programming
28 Additional info needed to program the FPGA image is passed in the struct
37 How to add a new FPGA region
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
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
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
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