Re: [PATCH 2/3] doc: dt: add cyclone-spi binding document
From: Moritz Fischer
Date: Thu Oct 06 2016 - 22:53:37 EST
On Thu, Oct 6, 2016 at 1:34 PM, Joshua Clayton <stillcompiling@xxxxxxxxx> wrote:
> Describe a cyclonespi devicetree entry, required features
> Signed-off-by: Joshua Clayton <stillcompiling@xxxxxxxxx>
> .../bindings/fpga/cyclone-spi-fpga-mgr.txt | 23 ++++++++++++++++++++++
> 1 file changed, 23 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/fpga/cyclone-spi-fpga-mgr.txt
> diff --git a/Documentation/devicetree/bindings/fpga/cyclone-spi-fpga-mgr.txt b/Documentation/devicetree/bindings/fpga/cyclone-spi-fpga-mgr.txt
> new file mode 100644
> index 0000000..8de34db
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/cyclone-spi-fpga-mgr.txt
> @@ -0,0 +1,23 @@
> +Altera SOCFPGA FPGA Manager
Copy & Paste? :)
> +Altera cyclone FPGAs support a method of loading the bitstream over what is
> +referred to as "passive serial".
> +The passive serial link is not technically spi, and might require extra
> +circuits in order to play nicely with other spi slaves on the same bus.
> +See https://www.altera.com/literature/hb/cyc/cyc_c51013.pdf
> +Required properties:
> +- compatible : should contain "altr,cyclonespi-fpga-mgr"
Alan, do you guys have any input on the compat string?
I think generally the bindings should go before the actual usage in
your patch series. Meaning you wanna document the binding
before you use it. I think this patch should be [1/3].