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() —  Register an FPGA region
51 * fpga_region_unregister() —  Unregister an FPGA region
53 The FPGA region's probe function will need to get a reference to the FPGA
57 * fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count
58 * of_fpga_mgr_get() —  Get a reference to an FPGA manager, raise ref count,
60 * fpga_mgr_put() — Put an FPGA manager
62 The FPGA region will need to specify which bridges to control while programming
63 the FPGA.  The region driver can build a list of bridges during probe time
66 (:c:expr:`fpga_region->get_bridges`).  The FPGA bridge framework supplies the
69 * fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
71 * of_fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a