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.
15 memory for the buffer should be avoided, users are encouraged to use a scatter
20 FPGA image as well as image-specific particulars such as whether the image was
24 --------------------------------
26 To add another FPGA manager, write a driver that implements a set of ops.  The
39 		struct device *dev = &pdev->dev;
46 			return -ENOMEM;
72 Alternatively, the probe function could call one of the resource managed
91 with initial_header_size. If flag skip_header of fpga_manager_ops is true,
93 beginning. If data_size is set, .write function will get data_size bytes of
94 the image buffer, otherwise .write will get data up to the end of image buffer.
97 whole buffer will be passed into .parse_header. If image is in scatter-gather
99 call of .parse_header, if it is not enough, .parse_header should set desired
100 size into info->header_size and return -EAGAIN, then it will be called again
101 with greater part of image buffer on the input.
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
111 is suitable for drivers which use PIO.
114 scatter list. This interface is suitable for drivers which use DMA.
120 and return a code of type enum fpga_mgr_states.  It doesn't result in a change
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
131   fpga_mgr_info structure to provide the full flexibility of options
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
141 to ease the registration.
143 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
146 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
149 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
152 .. kernel-doc:: include/linux/fpga/fpga-mgr.h
155 .. kernel-doc:: drivers/fpga/fpga-mgr.c
158 .. kernel-doc:: drivers/fpga/fpga-mgr.c
161 .. kernel-doc:: drivers/fpga/fpga-mgr.c
164 .. kernel-doc:: drivers/fpga/fpga-mgr.c
167 .. kernel-doc:: drivers/fpga/fpga-mgr.c