aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/fpga/fpga-mgr.rst
diff options
context:
space:
mode:
authorAlan Tull <atull@kernel.org>2018-06-27 21:56:19 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2018-07-07 10:56:09 -0400
commita59f95c7a2c35031264eafc62e684df07f5f2a8f (patch)
tree4aa6adf885c301b63250a8ff455f7e5f85dfae3c /Documentation/driver-api/fpga/fpga-mgr.rst
parent36cb055f1bcfd10e4565867a696ff688d9de3cf4 (diff)
Documentation: fpga: cleanup
Minor fixes including: * fix some typos * correct use of a/an * rephrase explanation of .state ops function * s/re-use/reuse/ (use only one spelling of 'reuse' in these docs) * s/cpu/CPU/ Signed-off-by: Alan Tull <atull@kernel.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api/fpga/fpga-mgr.rst')
-rw-r--r--Documentation/driver-api/fpga/fpga-mgr.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/driver-api/fpga/fpga-mgr.rst b/Documentation/driver-api/fpga/fpga-mgr.rst
index bcf2dd24e179..4b3825da48d9 100644
--- a/Documentation/driver-api/fpga/fpga-mgr.rst
+++ b/Documentation/driver-api/fpga/fpga-mgr.rst
@@ -83,7 +83,7 @@ The programming sequence is::
83 3. .write_complete 83 3. .write_complete
84 84
85The .write_init function will prepare the FPGA to receive the image data. The 85The .write_init function will prepare the FPGA to receive the image data. The
86buffer passed into .write_init will be atmost .initial_header_size bytes long, 86buffer passed into .write_init will be at most .initial_header_size bytes long;
87if the whole bitstream is not immediately available then the core code will 87if the whole bitstream is not immediately available then the core code will
88buffer up at least this much before starting. 88buffer up at least this much before starting.
89 89
@@ -98,9 +98,9 @@ scatter list. This interface is suitable for drivers which use DMA.
98The .write_complete function is called after all the image has been written 98The .write_complete function is called after all the image has been written
99to put the FPGA into operating mode. 99to put the FPGA into operating mode.
100 100
101The ops include a .state function which will read the hardware FPGA manager and 101The ops include a .state function which will determine the state the FPGA is in
102return a code of type enum fpga_mgr_states. It doesn't result in a change in 102and return a code of type enum fpga_mgr_states. It doesn't result in a change
103hardware state. 103in state.
104 104
105How to write an image buffer to a supported FPGA 105How to write an image buffer to a supported FPGA
106------------------------------------------------ 106------------------------------------------------
@@ -181,8 +181,8 @@ API for implementing a new FPGA Manager driver
181.. kernel-doc:: drivers/fpga/fpga-mgr.c 181.. kernel-doc:: drivers/fpga/fpga-mgr.c
182 :functions: fpga_mgr_unregister 182 :functions: fpga_mgr_unregister
183 183
184API for programming a FPGA 184API for programming an FPGA
185-------------------------- 185---------------------------
186 186
187.. kernel-doc:: include/linux/fpga/fpga-mgr.h 187.. kernel-doc:: include/linux/fpga/fpga-mgr.h
188 :functions: fpga_image_info 188 :functions: fpga_image_info