Commit 758f7467 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Moritz Fischer

docs: driver-api: fpga: avoid using UTF-8 chars

While UTF-8 characters can be used at the Linux documentation,
the best is to use them only when ASCII doesn't offer a good replacement.
So, replace the occurences of the following UTF-8 characters:

	- U+2014 ('—'): EM DASH
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarMoritz Fischer <mdf@kernel.org>
parent e73f0f0e
...@@ -4,11 +4,11 @@ FPGA Bridge ...@@ -4,11 +4,11 @@ FPGA Bridge
API to implement a new FPGA bridge API to implement a new FPGA bridge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* struct fpga_bridge The FPGA Bridge structure * struct fpga_bridge - The FPGA Bridge structure
* struct fpga_bridge_ops Low level Bridge driver ops * struct fpga_bridge_ops - Low level Bridge driver ops
* devm_fpga_bridge_create() Allocate and init a bridge struct * devm_fpga_bridge_create() - Allocate and init a bridge struct
* fpga_bridge_register() Register a bridge * fpga_bridge_register() - Register a bridge
* 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
......
...@@ -101,12 +101,12 @@ in state. ...@@ -101,12 +101,12 @@ in state.
API for implementing a new FPGA Manager driver API for implementing a new FPGA Manager driver
---------------------------------------------- ----------------------------------------------
* ``fpga_mgr_states`` Values for :c:expr:`fpga_manager->state`. * ``fpga_mgr_states`` - Values for :c:expr:`fpga_manager->state`.
* struct fpga_manager the FPGA manager struct * struct fpga_manager - the FPGA manager struct
* struct fpga_manager_ops Low level FPGA manager driver ops * struct fpga_manager_ops - Low level FPGA manager driver ops
* devm_fpga_mgr_create() Allocate and init a manager struct * devm_fpga_mgr_create() - Allocate and init a manager struct
* fpga_mgr_register() Register an FPGA manager * fpga_mgr_register() - Register an FPGA manager
* 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
......
...@@ -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
--------------------------- ---------------------------
* fpga_region_program_fpga() Program an FPGA * fpga_region_program_fpga() - Program an FPGA
* fpga_image_info() Specifies what FPGA image to program * fpga_image_info() - Specifies what FPGA image to program
* fpga_image_info_alloc() Allocate an FPGA image info struct * fpga_image_info_alloc() - Allocate an FPGA image info struct
* 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
......
...@@ -45,19 +45,19 @@ An example of usage can be seen in the probe function of [#f2]_. ...@@ -45,19 +45,19 @@ An example of usage can be seen in the probe function of [#f2]_.
API to add a new FPGA region API to add a new FPGA region
---------------------------- ----------------------------
* struct fpga_region The FPGA region struct * struct fpga_region - The FPGA region struct
* devm_fpga_region_create() Allocate and init a region struct * devm_fpga_region_create() - Allocate and init a region struct
* fpga_region_register() Register an FPGA region * fpga_region_register() - Register an FPGA region
* 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.
* 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
* 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.
* 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:expr:`fpga_region->get_bridges`). The FPGA bridge framework supplies the (:c:expr:`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.
* 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
* 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
* 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