Commit 78b8612e authored by Puranjay Mohan's avatar Puranjay Mohan Committed by Jonathan Corbet

Fpga: Documentation: Replace deprecated :c:func: Usage

Replace :c:func: with func() as the previous usage is deprecated.
Signed-off-by: default avatarPuranjay Mohan <puranjay12@gmail.com>
Link: https://lore.kernel.org/r/20200812180224.24810-1-puranjay12@gmail.comSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent a320274a
...@@ -6,9 +6,9 @@ API to implement a new FPGA bridge ...@@ -6,9 +6,9 @@ API to implement a new FPGA bridge
* struct :c:type:`fpga_bridge` — The FPGA Bridge structure * struct :c:type:`fpga_bridge` — The FPGA Bridge structure
* struct :c:type:`fpga_bridge_ops` — Low level Bridge driver ops * struct :c:type:`fpga_bridge_ops` — Low level Bridge driver ops
* :c:func:`devm_fpga_bridge_create()` — Allocate and init a bridge struct * devm_fpga_bridge_create() — Allocate and init a bridge struct
* :c:func:`fpga_bridge_register()` — Register a bridge * fpga_bridge_register() — Register a bridge
* :c:func:`fpga_bridge_unregister()` — Unregister a bridge * fpga_bridge_unregister() — Unregister a bridge
.. kernel-doc:: include/linux/fpga/fpga-bridge.h .. kernel-doc:: include/linux/fpga/fpga-bridge.h
:functions: fpga_bridge :functions: fpga_bridge
......
...@@ -104,9 +104,9 @@ API for implementing a new FPGA Manager driver ...@@ -104,9 +104,9 @@ API for implementing a new FPGA Manager driver
* ``fpga_mgr_states`` — Values for :c:member:`fpga_manager->state`. * ``fpga_mgr_states`` — Values for :c:member:`fpga_manager->state`.
* struct :c:type:`fpga_manager` — the FPGA manager struct * struct :c:type:`fpga_manager` — the FPGA manager struct
* struct :c:type:`fpga_manager_ops` — Low level FPGA manager driver ops * struct :c:type:`fpga_manager_ops` — Low level FPGA manager driver ops
* :c:func:`devm_fpga_mgr_create` — Allocate and init a manager struct * devm_fpga_mgr_create() — Allocate and init a manager struct
* :c:func:`fpga_mgr_register` — Register an FPGA manager * fpga_mgr_register() — Register an FPGA manager
* :c:func:`fpga_mgr_unregister` — Unregister an FPGA manager * fpga_mgr_unregister() — Unregister an FPGA manager
.. kernel-doc:: include/linux/fpga/fpga-mgr.h .. kernel-doc:: include/linux/fpga/fpga-mgr.h
:functions: fpga_mgr_states :functions: fpga_mgr_states
......
...@@ -6,9 +6,9 @@ Overview ...@@ -6,9 +6,9 @@ Overview
The in-kernel API for FPGA programming is a combination of APIs from The in-kernel API for FPGA programming is a combination of APIs from
FPGA manager, bridge, and regions. The actual function used to 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: the FPGA manager and bridges. It will:
* lock the region's mutex * lock the region's mutex
...@@ -20,8 +20,8 @@ the FPGA manager and bridges. It will: ...@@ -20,8 +20,8 @@ the FPGA manager and bridges. It will:
* release the locks * release the locks
The struct fpga_image_info specifies what FPGA image to program. It is 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 allocated/freed by fpga_image_info_alloc() and freed with
:c:func:`fpga_image_info_free()` fpga_image_info_free()
How to program an FPGA using a region 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:: ...@@ -84,10 +84,10 @@ will generate that list. Here's some sample code of what to do next::
API for programming an FPGA API for programming an FPGA
--------------------------- ---------------------------
* :c:func:`fpga_region_program_fpga` — Program an FPGA * fpga_region_program_fpga() — Program an FPGA
* :c:type:`fpga_image_info` — Specifies what FPGA image to program * fpga_image_info() — Specifies what FPGA image to program
* :c:func:`fpga_image_info_alloc()` — Allocate an FPGA image info struct * fpga_image_info_alloc() — Allocate an FPGA image info struct
* :c:func:`fpga_image_info_free()` — Free an FPGA image info struct * fpga_image_info_free() — Free an FPGA image info struct
.. kernel-doc:: drivers/fpga/fpga-region.c .. kernel-doc:: drivers/fpga/fpga-region.c
:functions: fpga_region_program_fpga :functions: fpga_region_program_fpga
......
...@@ -46,18 +46,18 @@ API to add a new FPGA region ...@@ -46,18 +46,18 @@ API to add a new FPGA region
---------------------------- ----------------------------
* struct :c:type:`fpga_region` — The FPGA region struct * struct :c:type:`fpga_region` — The FPGA region struct
* :c:func:`devm_fpga_region_create` — Allocate and init a region struct * devm_fpga_region_create() — Allocate and init a region struct
* :c:func:`fpga_region_register` — Register an FPGA region * fpga_region_register() — Register an FPGA region
* :c:func:`fpga_region_unregister` — Unregister an FPGA region * fpga_region_unregister() — Unregister an FPGA region
The FPGA region's probe function will need to get a reference to the FPGA The FPGA region's probe function will need to get a reference to the FPGA
Manager it will be using to do the programming. This usually would happen Manager it will be using to do the programming. This usually would happen
during the region's probe function. during the region's probe function.
* :c:func:`fpga_mgr_get` — Get a reference to an FPGA manager, raise ref count * fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count
* :c:func:`of_fpga_mgr_get` — Get a reference to an FPGA manager, raise ref count, * of_fpga_mgr_get() — Get a reference to an FPGA manager, raise ref count,
given a device node. given a device node.
* :c:func:`fpga_mgr_put` — Put an FPGA manager * fpga_mgr_put() — Put an FPGA manager
The FPGA region will need to specify which bridges to control while programming The FPGA region will need to specify which bridges to control while programming
the FPGA. The region driver can build a list of bridges during probe time the FPGA. The region driver can build a list of bridges during probe time
...@@ -66,11 +66,11 @@ the list of bridges to program just before programming ...@@ -66,11 +66,11 @@ the list of bridges to program just before programming
(:c:member:`fpga_region->get_bridges`). The FPGA bridge framework supplies the (:c:member:`fpga_region->get_bridges`). The FPGA bridge framework supplies the
following APIs to handle building or tearing down that list. following APIs to handle building or tearing down that list.
* :c:func:`fpga_bridge_get_to_list` — Get a ref of an FPGA bridge, add it to a * fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
list list
* :c:func:`of_fpga_bridge_get_to_list` — Get a ref of an FPGA bridge, add it to a * of_fpga_bridge_get_to_list() — Get a ref of an FPGA bridge, add it to a
list, given a device node list, given a device node
* :c:func:`fpga_bridges_put` — Given a list of bridges, put them * fpga_bridges_put() — Given a list of bridges, put them
.. kernel-doc:: include/linux/fpga/fpga-region.h .. kernel-doc:: include/linux/fpga/fpga-region.h
:functions: fpga_region :functions: fpga_region
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment