Skip to content

Commit a59f95c

Browse files
atull-alteragregkh
authored andcommitted
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>
1 parent 36cb055 commit a59f95c

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

Documentation/driver-api/fpga/fpga-mgr.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ The programming sequence is::
8383
3. .write_complete
8484

8585
The .write_init function will prepare the FPGA to receive the image data. The
86-
buffer passed into .write_init will be atmost .initial_header_size bytes long,
86+
buffer passed into .write_init will be at most .initial_header_size bytes long;
8787
if the whole bitstream is not immediately available then the core code will
8888
buffer up at least this much before starting.
8989

@@ -98,9 +98,9 @@ scatter list. This interface is suitable for drivers which use DMA.
9898
The .write_complete function is called after all the image has been written
9999
to put the FPGA into operating mode.
100100

101-
The ops include a .state function which will read the hardware FPGA manager and
102-
return a code of type enum fpga_mgr_states. It doesn't result in a change in
103-
hardware state.
101+
The ops include a .state function which will determine the state the FPGA is in
102+
and return a code of type enum fpga_mgr_states. It doesn't result in a change
103+
in state.
104104

105105
How to write an image buffer to a supported FPGA
106106
------------------------------------------------
@@ -181,8 +181,8 @@ API for implementing a new FPGA Manager driver
181181
.. kernel-doc:: drivers/fpga/fpga-mgr.c
182182
:functions: fpga_mgr_unregister
183183

184-
API for programming a FPGA
185-
--------------------------
184+
API for programming an FPGA
185+
---------------------------
186186

187187
.. kernel-doc:: include/linux/fpga/fpga-mgr.h
188188
:functions: fpga_image_info

Documentation/driver-api/fpga/fpga-region.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ FPGA Region
44
Overview
55
--------
66

7-
This document is meant to be an brief overview of the FPGA region API usage. A
7+
This document is meant to be a brief overview of the FPGA region API usage. A
88
more conceptual look at regions can be found in the Device Tree binding
99
document [#f1]_.
1010

@@ -31,11 +31,11 @@ fpga_image_info including:
3131
* pointers to the image as either a scatter-gather buffer, a contiguous
3232
buffer, or the name of firmware file
3333

34-
* flags indicating specifics such as whether the image if for partial
34+
* flags indicating specifics such as whether the image is for partial
3535
reconfiguration.
3636

37-
How to program a FPGA using a region
38-
------------------------------------
37+
How to program an FPGA using a region
38+
-------------------------------------
3939

4040
First, allocate the info struct::
4141

@@ -77,8 +77,8 @@ An example of usage can be seen in the probe function of [#f2]_.
7777
.. [#f1] ../devicetree/bindings/fpga/fpga-region.txt
7878
.. [#f2] ../../drivers/fpga/of-fpga-region.c
7979
80-
API to program a FGPA
81-
---------------------
80+
API to program an FPGA
81+
----------------------
8282

8383
.. kernel-doc:: drivers/fpga/fpga-region.c
8484
:functions: fpga_region_program_fpga

Documentation/driver-api/fpga/intro.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Linux. Some of the core intentions of the FPGA subsystems are:
1212

1313
* Code should not be shared between upper and lower layers. This
1414
should go without saying. If that seems necessary, there's probably
15-
framework functionality that that can be added that will benefit
15+
framework functionality that can be added that will benefit
1616
other users. Write the linux-fpga mailing list and maintainers and
1717
seek out a solution that expands the framework for broad reuse.
1818

19-
* Generally, when adding code, think of the future. Plan for re-use.
19+
* Generally, when adding code, think of the future. Plan for reuse.
2020

2121
The framework in the kernel is divided into:
2222

2323
FPGA Manager
2424
------------
2525

26-
If you are adding a new FPGA or a new method of programming a FPGA,
26+
If you are adding a new FPGA or a new method of programming an FPGA,
2727
this is the subsystem for you. Low level FPGA manager drivers contain
2828
the knowledge of how to program a specific device. This subsystem
2929
includes the framework in fpga-mgr.c and the low level drivers that
@@ -32,10 +32,10 @@ are registered with it.
3232
FPGA Bridge
3333
-----------
3434

35-
FPGA Bridges prevent spurious signals from going out of a FPGA or a
36-
region of a FPGA during programming. They are disabled before
35+
FPGA Bridges prevent spurious signals from going out of an FPGA or a
36+
region of an FPGA during programming. They are disabled before
3737
programming begins and re-enabled afterwards. An FPGA bridge may be
38-
actual hard hardware that gates a bus to a cpu or a soft ("freeze")
38+
actual hard hardware that gates a bus to a CPU or a soft ("freeze")
3939
bridge in FPGA fabric that surrounds a partial reconfiguration region
4040
of an FPGA. This subsystem includes fpga-bridge.c and the low level
4141
drivers that are registered with it.
@@ -44,7 +44,7 @@ FPGA Region
4444
-----------
4545

4646
If you are adding a new interface to the FPGA framework, add it on top
47-
of a FPGA region to allow the most reuse of your interface.
47+
of an FPGA region to allow the most reuse of your interface.
4848

4949
The FPGA Region framework (fpga-region.c) associates managers and
5050
bridges as reconfigurable regions. A region may refer to the whole

0 commit comments

Comments
 (0)