diff options
| author | Linus Torvalds <[email protected]> | 2020-08-31 12:46:00 -0700 |
|---|---|---|
| committer | Linus Torvalds <[email protected]> | 2020-08-31 12:46:00 -0700 |
| commit | b51594df17d0ce80b9f9f35394a1f42d7ac94472 (patch) | |
| tree | d8721d4cc0eb59d6480ebfebc7718db18a6f0f99 /Documentation/driver-api/fpga/fpga-programming.rst | |
| parent | 59815d6d1c773f3609ef9da50881a47e9cba9c25 (diff) | |
| parent | 92001bc0365a144783f8f3108be94e74baf61011 (diff) | |
Merge tag 'docs-5.9-3' of git://git.lwn.net/linux
Pull documentation fixes from Jonathan Corbet:
"A handful of documentation fixes for 5.9"
* tag 'docs-5.9-3' of git://git.lwn.net/linux:
Documentation: laptops: thinkpad-acpi: fix underline length build warning
Documentation: fix typo for abituguru documentation
docs: Fix function name trailing double-()s
devices.txt: fix typo of "ubd" as "udb"
Documentation: add riscv entry in list of existing profiles
MAINTAINERS: mention documentation maintainer entry profile
Fpga: Documentation: Replace deprecated :c:func: Usage
IIO: Documentation: Replace deprecated :c:func: Usage
Documentation/locking/locktypes: fix local_locks documentation
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 |