lkml.org 
[lkml]   [2022]   [Jul]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 2/2] dt-bindings: fpga: add binding doc for ecp5-spi fpga mgr
On Mon, Jul 18, 2022 at 03:58:22PM +0200, Krzysztof Kozlowski wrote:
> On 18/07/2022 13:49, Ivan Bornyakov wrote:
> > Add Device Tree Binding doc for Lattice ECP5 FPGA manager using slave
> > SPI to load .bit formatted uncompressed bitstream image.
> >
> > Signed-off-by: Ivan Bornyakov <i.bornyakov@metrotek.ru>
> > ---
> > .../bindings/fpga/lattice,ecp5-fpga-mgr.yaml | 73 +++++++++++++++++++
> > 1 file changed, 73 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/fpga/lattice,ecp5-fpga-mgr.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/fpga/lattice,ecp5-fpga-mgr.yaml b/Documentation/devicetree/bindings/fpga/lattice,ecp5-fpga-mgr.yaml
> > new file mode 100644
> > index 000000000000..bb10fd316f94
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/fpga/lattice,ecp5-fpga-mgr.yaml
> > @@ -0,0 +1,73 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/fpga/lattice,ecp5-fpga-mgr.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Lattice ECP5 Slave SPI FPGA manager.
> > +
> > +maintainers:
> > + - Ivan Bornyakov <i.bornyakov@metrotek.ru>
> > +
> > +description:
> > + FPGA Manager capable to program Lattice ECP5 with uncompressed bitstream
> > + image in .bit format over SPI.
>
> The same question as before - you need to explain what is the hardware
> (not Linux API or Linux subsystem).
>

I really don't know what to say aside from "thing that capable to
program FPGA". Is there a good exmple of proper wording in
Documentation/devicetree/bindings/fpga/?
Otherwise I would ask FPGA Manager framework maintainers assistance on
how to describe a FPGA Manager driver.

> > +
> > +allOf:
> > + - $ref: /schemas/spi/spi-peripheral-props.yaml
> > +
> > +properties:
> > + reg:
> > + maxItems: 1
> > +
> > + spi-max-frequency:
> > + maximum: 60000000
> > +
> > + compatible:
> > + enum:
> > + - lattice,ecp5-fpga-mgr
>
> Compatible goes first in the list of properties. Change here was not
> requested, so I am surprised to see different coding style.
>
> > +
> > + program-gpios:
> > + description:
> > + A GPIO line connected to PROGRAMN (active low) pin of the device.
> > + Initiates configuration sequence.
> > + maxItems: 1
> > +
> > + init-gpios:
> > + description:
> > + A GPIO line connected to INITN (active low) pin of the device.
> > + Indicates that the FPGA is ready to be configured.
> > + maxItems: 1
> > +
> > + done-gpios:
> > + description:
> > + A GPIO line connected to DONE (active high) pin of the device.
> > + Indicates that the configuration sequence is complete.
> > + maxItems: 1
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - program-gpios
> > + - init-gpios
> > + - done-gpios
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/gpio/gpio.h>
> > +
> > + spi {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + fpga-mgr@0 {
> > + compatible = "lattice,ecp5-fpga-mgr";
> > + spi-max-frequency = <20000000>;
> > + reg = <0>;
>
> compatible then reg, then rest of properties.
>
>
>
> Best regards,
> Krzysztof

\
 
 \ /
  Last update: 2022-07-18 16:26    [W:0.090 / U:0.132 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site