driver-api/fpga/fpga-mgr.rst

5 --------
7 The FPGA manager core exports a set of functions for programming an FPGA with
9 hidden away in a low level driver which registers a set of ops with the core.
13 The FPGA image to be programmed can be in a scatter gather list, a single
18 The particulars for programming the image are presented in a structure (struct
20 FPGA image as well as image-specific particulars such as whether the image was
24 --------------------------------
39 		struct device *dev = &pdev->dev;
46 			return -ENOMEM;
50 		 * them in priv
73 register functions, ``devm_fpga_mgr_register()`` or
74 ``devm_fpga_mgr_register_full()``.  When these functions are used, the
76 removed. In the above example, the ``socfpga_fpga_remove()`` function would not be
95 This will not affect .write_sg, .write_sg will still get whole image in
97 whole buffer will be passed into .parse_header. If image is in scatter-gather
100 size into info->header_size and return -EAGAIN, then it will be called again
104 buffer passed into .write_init will be at least info->header_size bytes long;
109 whole FPGA image or may be a smaller chunk of an FPGA image.  In the latter
119 The ops include a .state function which will determine the state the FPGA is in
120 and return a code of type enum fpga_mgr_states.  It doesn't result in a change
121 in state.
124 ----------------------------------------------
126 * ``fpga_mgr_states`` -  Values for :c:expr:`fpga_manager->state`.
127 * struct fpga_manager -  the FPGA manager struct
128 * struct fpga_manager_ops -  Low level FPGA manager driver ops
129 * struct fpga_manager_info -  Parameter structure for fpga_mgr_register_full()
130 * __fpga_mgr_register_full() -  Create and register an FPGA manager using the
132 * __fpga_mgr_register() -  Create and register an FPGA manager using standard
134 * __devm_fpga_mgr_register_full() -  Resource managed version of
136 * __devm_fpga_mgr_register() -  Resource managed version of __fpga_mgr_register()
137 * fpga_mgr_unregister() -  Unregister an FPGA manager
143 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
144    :functions: fpga_mgr_states
146 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
147    :functions: fpga_manager
149 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
150    :functions: fpga_manager_ops
152 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
153    :functions: fpga_manager_info
155 .. kernel-doc:: drivers/fpga/fpga-mgr.c
156    :functions: __fpga_mgr_register_full
158 .. kernel-doc:: drivers/fpga/fpga-mgr.c
159    :functions: __fpga_mgr_register
161 .. kernel-doc:: drivers/fpga/fpga-mgr.c
162    :functions: __devm_fpga_mgr_register_full
164 .. kernel-doc:: drivers/fpga/fpga-mgr.c
165    :functions: __devm_fpga_mgr_register
167 .. kernel-doc:: drivers/fpga/fpga-mgr.c
168    :functions: fpga_mgr_unregister