diff options
author | Vinod Koul <vkoul@kernel.org> | 2020-09-11 17:45:36 +0530 |
---|---|---|
committer | Vinod Koul <vkoul@kernel.org> | 2020-09-11 17:45:36 +0530 |
commit | 4c80e9323967125ab8aa7c271ccc7624abc08832 (patch) | |
tree | c9881b5814c184aa0c1cb58c6383beab9173e388 /Documentation/driver-api/fpga/fpga-programming.rst | |
parent | ef759e4a28c88965972c815af6023f41bd733316 (diff) | |
parent | f4d51dffc6c01a9e94650d95ce0104964f8ae822 (diff) |
Merge tag 'v5.9-rc4' into next
Linux 5.9-rc4
Diffstat (limited to 'Documentation/driver-api/fpga/fpga-programming.rst')
-rw-r--r-- | Documentation/driver-api/fpga/fpga-programming.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/driver-api/fpga/fpga-programming.rst b/Documentation/driver-api/fpga/fpga-programming.rst index b5484df6ff0f..f487ad64dfb9 100644 --- a/Documentation/driver-api/fpga/fpga-programming.rst +++ b/Documentation/driver-api/fpga/fpga-programming.rst @@ -6,9 +6,9 @@ Overview The in-kernel API for FPGA programming is a combination of APIs from FPGA manager, bridge, and regions. The actual function used to -trigger FPGA programming is :c:func:`fpga_region_program_fpga()`. +trigger FPGA programming is fpga_region_program_fpga(). -:c:func:`fpga_region_program_fpga()` uses functionality supplied by +fpga_region_program_fpga() uses functionality supplied by the FPGA manager and bridges. It will: * lock the region's mutex @@ -20,8 +20,8 @@ the FPGA manager and bridges. It will: * release the locks The struct fpga_image_info specifies what FPGA image to program. It is -allocated/freed by :c:func:`fpga_image_info_alloc()` and freed with -:c:func:`fpga_image_info_free()` +allocated/freed by fpga_image_info_alloc() and freed with +fpga_image_info_free() How to program an FPGA using a region ------------------------------------- @@ -84,10 +84,10 @@ will generate that list. Here's some sample code of what to do next:: API for programming an FPGA --------------------------- -* :c:func:`fpga_region_program_fpga` — Program an FPGA -* :c:type:`fpga_image_info` — Specifies what FPGA image to program -* :c:func:`fpga_image_info_alloc()` — Allocate an FPGA image info struct -* :c:func:`fpga_image_info_free()` — Free an FPGA image info struct +* fpga_region_program_fpga() — Program an FPGA +* fpga_image_info() — Specifies what FPGA image to program +* fpga_image_info_alloc() — Allocate an FPGA image info struct +* fpga_image_info_free() — Free an FPGA image info struct .. kernel-doc:: drivers/fpga/fpga-region.c :functions: fpga_region_program_fpga |