driver-api/fpga/fpga-programming.rst

1 In-kernel API for FPGA Programming
7 The in-kernel API for FPGA programming is a combination of APIs from
8 FPGA manager, bridge, and regions.  The actual function used to
9 trigger FPGA programming is fpga_region_program_fpga().
12 the FPGA manager and bridges.  It will:
15  * lock the mutex of the region's FPGA manager
16  * build a list of FPGA bridges if a method has been specified to do so
18  * program the FPGA using info passed in :c:expr:`fpga_region->info`.
22 The struct fpga_image_info specifies what FPGA image to program.  It is
26 How to program an FPGA using a region
29 When the FPGA region driver probed, it was given a pointer to an FPGA manager
41 	 * First, alloc the struct with information about the FPGA image to
52 	 * Indicate where the FPGA image is. This is pseudo-code; you're
82 	/* Now enumerate whatever hardware has appeared in the FPGA. */
84 API for programming an FPGA
87 * fpga_region_program_fpga() -  Program an FPGA
88 * fpga_image_info() -  Specifies what FPGA image to program
89 * fpga_image_info_alloc() -  Allocate an FPGA image info struct
90 * fpga_image_info_free() -  Free an FPGA image info struct
95 FPGA Manager flags
98    :doc: FPGA Manager flags