Commit 0508c477 authored by Tom Rix's avatar Tom Rix Committed by Greg Kroah-Hartman

dt-bindings: fpga: fpga-region: change FPGA indirect article to an

Change use of 'a fpga' to 'an fpga'
Signed-off-by: default avatarTom Rix <trix@redhat.com>
Link: https://lore.kernel.org/r/20210608212350.3029742-3-trix@redhat.comSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent d208cbb0
...@@ -38,7 +38,7 @@ Partial Reconfiguration (PR) ...@@ -38,7 +38,7 @@ Partial Reconfiguration (PR)
Partial Reconfiguration Region (PRR) Partial Reconfiguration Region (PRR)
* Also called a "reconfigurable partition" * Also called a "reconfigurable partition"
* A PRR is a specific section of a FPGA reserved for reconfiguration. * A PRR is a specific section of an FPGA reserved for reconfiguration.
* A base (or static) FPGA image may create a set of PRR's that later may * A base (or static) FPGA image may create a set of PRR's that later may
be independently reprogrammed many times. be independently reprogrammed many times.
* The size and specific location of each PRR is fixed. * The size and specific location of each PRR is fixed.
...@@ -105,7 +105,7 @@ reprogrammed independently while the rest of the system continues to function. ...@@ -105,7 +105,7 @@ reprogrammed independently while the rest of the system continues to function.
Sequence Sequence
======== ========
When a DT overlay that targets a FPGA Region is applied, the FPGA Region will When a DT overlay that targets an FPGA Region is applied, the FPGA Region will
do the following: do the following:
1. Disable appropriate FPGA bridges. 1. Disable appropriate FPGA bridges.
...@@ -134,8 +134,8 @@ The intended use is that a Device Tree overlay (DTO) can be used to reprogram an ...@@ -134,8 +134,8 @@ The intended use is that a Device Tree overlay (DTO) can be used to reprogram an
FPGA while an operating system is running. FPGA while an operating system is running.
An FPGA Region that exists in the live Device Tree reflects the current state. An FPGA Region that exists in the live Device Tree reflects the current state.
If the live tree shows a "firmware-name" property or child nodes under a FPGA If the live tree shows a "firmware-name" property or child nodes under an FPGA
Region, the FPGA already has been programmed. A DTO that targets a FPGA Region Region, the FPGA already has been programmed. A DTO that targets an FPGA Region
and adds the "firmware-name" property is taken as a request to reprogram the and adds the "firmware-name" property is taken as a request to reprogram the
FPGA. After reprogramming is successful, the overlay is accepted into the live FPGA. After reprogramming is successful, the overlay is accepted into the live
tree. tree.
...@@ -152,9 +152,9 @@ These FPGA regions are children of FPGA bridges which are then children of the ...@@ -152,9 +152,9 @@ These FPGA regions are children of FPGA bridges which are then children of the
base FPGA region. The "Full Reconfiguration to add PRR's" example below shows base FPGA region. The "Full Reconfiguration to add PRR's" example below shows
this. this.
If an FPGA Region does not specify a FPGA Manager, it will inherit the FPGA If an FPGA Region does not specify an FPGA Manager, it will inherit the FPGA
Manager specified by its ancestor FPGA Region. This supports both the case Manager specified by its ancestor FPGA Region. This supports both the case
where the same FPGA Manager is used for all of a FPGA as well the case where where the same FPGA Manager is used for all of an FPGA as well the case where
a different FPGA Manager is used for each region. a different FPGA Manager is used for each region.
FPGA Regions do not inherit their ancestor FPGA regions' bridges. This prevents FPGA Regions do not inherit their ancestor FPGA regions' bridges. This prevents
...@@ -166,7 +166,7 @@ within the static image of the FPGA. ...@@ -166,7 +166,7 @@ within the static image of the FPGA.
Required properties: Required properties:
- compatible : should contain "fpga-region" - compatible : should contain "fpga-region"
- fpga-mgr : should contain a phandle to an FPGA Manager. Child FPGA Regions - fpga-mgr : should contain a phandle to an FPGA Manager. Child FPGA Regions
inherit this property from their ancestor regions. A fpga-mgr property inherit this property from their ancestor regions. An fpga-mgr property
in a region will override any inherited FPGA manager. in a region will override any inherited FPGA manager.
- #address-cells, #size-cells, ranges : must be present to handle address space - #address-cells, #size-cells, ranges : must be present to handle address space
mapping for child nodes. mapping for child nodes.
...@@ -175,12 +175,12 @@ Optional properties: ...@@ -175,12 +175,12 @@ Optional properties:
- firmware-name : should contain the name of an FPGA image file located on the - firmware-name : should contain the name of an FPGA image file located on the
firmware search path. If this property shows up in a live device tree firmware search path. If this property shows up in a live device tree
it indicates that the FPGA has already been programmed with this image. it indicates that the FPGA has already been programmed with this image.
If this property is in an overlay targeting a FPGA region, it is a If this property is in an overlay targeting an FPGA region, it is a
request to program the FPGA with that image. request to program the FPGA with that image.
- fpga-bridges : should contain a list of phandles to FPGA Bridges that must be - fpga-bridges : should contain a list of phandles to FPGA Bridges that must be
controlled during FPGA programming along with the parent FPGA bridge. controlled during FPGA programming along with the parent FPGA bridge.
This property is optional if the FPGA Manager handles the bridges. This property is optional if the FPGA Manager handles the bridges.
If the fpga-region is the child of a fpga-bridge, the list should not If the fpga-region is the child of an fpga-bridge, the list should not
contain the parent bridge. contain the parent bridge.
- partial-fpga-config : boolean, set if partial reconfiguration is to be done, - partial-fpga-config : boolean, set if partial reconfiguration is to be done,
otherwise full reconfiguration is done. otherwise full reconfiguration is done.
...@@ -279,7 +279,7 @@ Supported Use Models ...@@ -279,7 +279,7 @@ Supported Use Models
In all cases the live DT must have the FPGA Manager, FPGA Bridges (if any), and In all cases the live DT must have the FPGA Manager, FPGA Bridges (if any), and
a FPGA Region. The target of the Device Tree Overlay is the FPGA Region. Some a FPGA Region. The target of the Device Tree Overlay is the FPGA Region. Some
uses are specific to a FPGA device. uses are specific to an FPGA device.
* No FPGA Bridges * No FPGA Bridges
In this case, the FPGA Manager which programs the FPGA also handles the In this case, the FPGA Manager which programs the FPGA also handles the
...@@ -300,7 +300,7 @@ uses are specific to a FPGA device. ...@@ -300,7 +300,7 @@ uses are specific to a FPGA device.
bridges need to exist in the FPGA that can gate the buses going to each FPGA bridges need to exist in the FPGA that can gate the buses going to each FPGA
region while the buses are enabled for other sections. Before any partial region while the buses are enabled for other sections. Before any partial
reconfiguration can be done, a base FPGA image must be loaded which includes reconfiguration can be done, a base FPGA image must be loaded which includes
PRR's with FPGA bridges. The device tree should have a FPGA region for each PRR's with FPGA bridges. The device tree should have an FPGA region for each
PRR. PRR.
Device Tree Examples Device Tree Examples
......
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