dt-bindings: fpga: Add Efinix serial SPI programming binding description
Subsystems (2)
PATCH 2/3 dt-bindings: fpga: Add Efinix serial SPI programming binding description
From: Ian Dannapel <[email protected]>
Add device tree binding documentation for configuring Efinix FPGA using serial SPI passive programming mode.
--- .../bindings/fpga/efnx,fpga-passive-spi.yaml | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +76 -0
@@ -0,0 +1,76 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/fpga/efnx,fpga-passive-spi.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Efinix SPI FPGA Manager + +description: | + Efinix Trion and Titanium Series FPGAs support a method of loading the + bitstream over what is referred to as "SPI Passive Programming". + Only serial (1x bus width) is supported, setting the programming mode + is not in the scope the this manager and must be done elsewhere. + + References: + - https://www.efinixinc.com/docs/an033-configuring-titanium-fpgas-v2.6.pdf + - https://www.efinixinc.com/docs/an006-configuring-trion-fpgas-v6.0.pdf + +allOf: + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + enum: + - efnx,fpga-spi-passive + + spi-cpha: true + spi-cpol: true + + spi-max-frequency: + maximum: 25000000 + + reg: + maxItems: 1 + + reset-gpios: + description: + reset pin (low active) + maxItems: 1 + + cs-gpios: + description: + chip-select pin (low active) + maxItems: 1 + + done-gpios: + description: + optional programming done pin, referred as CDONE (high active) + maxItems: 1 + +required: + - compatible + - reg + - reset-gpios + - cs-gpios + +additionalProperties: false + +examples: + - | + &spi2 { + #address-cells = <1>; + #size-cells = <0>; + + fpga_mgr_spi: fpga-mgr@0 { + compatible = "efnx,fpga-spi-passive"; + spi-max-frequency = <25000000>; + spi-cpha; + spi-cpol; + reg = <0>; + reset-gpios = <&gpio4 17 GPIO_ACTIVE_LOW>; + cs-gpios = <&gpio5 13 GPIO_ACTIVE_LOW>; + done-gpios = <&gpio0 9 GPIO_ACTIVE_HIGH>; + }; + }; +...
Signature · 1 line
2.34.1
Quoted 32 lines · On Thu, Jun 20, 2024 at 04:44:40PM +0200, [email protected] wrote:
From: Ian Dannapel <[email protected]>
Add device tree binding documentation for configuring Efinix FPGA using serial SPI passive programming mode.
Signed-off-by Ian Dannapel <[email protected]>--- .../bindings/fpga/efnx,fpga-passive-spi.yaml | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yamlDocumentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +15
-0@@ -0,0 +1,76 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/fpga/efnx,fpga-passive-spi.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Efinix SPI FPGA Manager + +description: | + Efinix Trion and Titanium Series FPGAs support a method of loading the + bitstream over what is referred to as "SPI Passive Programming". + Only serial (1x bus width) is supported, setting the programming mode + is not in the scope the this manager and must be done elsewhere. + + References:
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 25
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ - https://www.efinixinc.com/docs/an033-configuring-titanium-fpgas-v2.6.pdf + - https://www.efinixinc.com/docs/an006-configuring-trion-fpgas-v6.0.pdf + +allOf: + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + enum: + - efnx,fpga-spi-passive
Ahh, here is the user. Can you please add specific compatibles for the Trion and Titanium series FPGAs? And when you do, make the filename match a compatible please.
Additionally, why "efnx" and not "efinix"?
Quoted 13 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +13
-0+ + spi-cpha: true + spi-cpol: true + + spi-max-frequency: + maximum: 25000000 + + reg: + maxItems: 1 + + reset-gpios: + description: + reset pin (low active)
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 48
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ maxItems: 1 + + cs-gpios: + description: + chip-select pin (low active) + maxItems: 1 + + done-gpios: + description: + optional programming done pin, referred as CDONE (high active)
Why not call it "cdone-gpios" if that;s what it is referred to as?
Quoted 12 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +12
-0+ maxItems: 1 + +required: + - compatible + - reg + - reset-gpios + - cs-gpios + +additionalProperties: false + +examples: + - |
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 70
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ &spi2 { + #address-cells = <1>; + #size-cells = <0>; + + fpga_mgr_spi: fpga-mgr@0 { + compatible = "efnx,fpga-spi-passive"; + spi-max-frequency = <25000000>; + spi-cpha; + spi-cpol; + reg = <0>;
order of compatible, reg, others here please.
Quoted 9 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +6
-0+ reset-gpios = <&gpio4 17 GPIO_ACTIVE_LOW>; + cs-gpios = <&gpio5 13 GPIO_ACTIVE_LOW>; + done-gpios = <&gpio0 9 GPIO_ACTIVE_HIGH>; + }; + }; +...Signature · 1 line
2.34.1
Hello,
Am Thu, Jun 20, 2024 at 04:47:41PM +0100 schrieb Conor Dooley:
Quoted 48 lines · On Thu, Jun 20, 2024 at 04:44:40PM +0200, [email protected] wrote:
Quoted 32 lines
From: Ian Dannapel <[email protected]>
Add device tree binding documentation for configuring Efinix FPGA using serial SPI passive programming mode.
Signed-off-by Ian Dannapel <[email protected]>--- .../bindings/fpga/efnx,fpga-passive-spi.yaml | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yamlDocumentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +15
-0@@ -0,0 +1,76 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/fpga/efnx,fpga-passive-spi.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Efinix SPI FPGA Manager + +description: | + Efinix Trion and Titanium Series FPGAs support a method of loading the + bitstream over what is referred to as "SPI Passive Programming". + Only serial (1x bus width) is supported, setting the programming mode + is not in the scope the this manager and must be done elsewhere. + + References:Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 25
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ - https://www.efinixinc.com/docs/an033-configuring-titanium-fpgas-v2.6.pdf + - https://www.efinixinc.com/docs/an006-configuring-trion-fpgas-v6.0.pdf + +allOf: + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + enum: + - efnx,fpga-spi-passiveAhh, here is the user. Can you please add specific compatibles for the Trion and Titanium series FPGAs? And when you do, make the filename match a compatible please.
Quoted 1 line
Additionally, why "efnx" and not "efinix"?
FWIW, there already is "altr,fpga-passive-serial" for Altera devices.
Not sure why Altera got this short vendor prefix, but that was 2013 with commit 5db17a71a526 ("of: add vendor prefix for Altera Corp.") and we probably never know?
The method of transferring the configuration data over SPI into the FPGA is comparable. I would go so far to claim a single driver could support both device families for passive configuration over SPI. I've done that in a non-public driver for U-Boot few months ago, and used "efinix,fpga-passive-serial" as a compatible there. The difference is basically Altera requiring more GPIOs considered, and Efinix keeping the SPI clock on for some time after data is already transfered.
Greets
Alex
Quoted 61 lines
Quoted 14 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +13
-0+ + spi-cpha: true + spi-cpol: true + + spi-max-frequency: + maximum: 25000000 + + reg: + maxItems: 1 + + reset-gpios: + description: + reset pin (low active)Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 48
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ maxItems: 1 + + cs-gpios: + description: + chip-select pin (low active) + maxItems: 1 + + done-gpios: + description: + optional programming done pin, referred as CDONE (high active)Why not call it "cdone-gpios" if that;s what it is referred to as?
Quoted 12 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +12
-0+ maxItems: 1 + +required: + - compatible + - reg + - reset-gpios + - cs-gpios + +additionalProperties: false + +examples: + - |Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 70
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ &spi2 { + #address-cells = <1>; + #size-cells = <0>; + + fpga_mgr_spi: fpga-mgr@0 { + compatible = "efnx,fpga-spi-passive"; + spi-max-frequency = <25000000>; + spi-cpha; + spi-cpol; + reg = <0>;order of compatible, reg, others here please.
Quoted 9 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +6
-0+ reset-gpios = <&gpio4 17 GPIO_ACTIVE_LOW>; + cs-gpios = <&gpio5 13 GPIO_ACTIVE_LOW>; + done-gpios = <&gpio0 9 GPIO_ACTIVE_HIGH>; + }; + }; +...Signature · 1 line
2.34.1
Quoted 49 lines · Alexander Dahl
Am Thu, Jun 20, 2024 at 04:47:41PM +0100 schrieb Conor Dooley:
Quoted 48 lines · On Thu, Jun 20, 2024 at 04:44:40PM +0200, [email protected] wrote:
Quoted 32 lines
From: Ian Dannapel <[email protected]>
Add device tree binding documentation for configuring Efinix FPGA using serial SPI passive programming mode.
Signed-off-by Ian Dannapel <[email protected]>--- .../bindings/fpga/efnx,fpga-passive-spi.yaml | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yamlDocumentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +15
-0@@ -0,0 +1,76 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/fpga/efnx,fpga-passive-spi.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Efinix SPI FPGA Manager + +description: | + Efinix Trion and Titanium Series FPGAs support a method of loading the + bitstream over what is referred to as "SPI Passive Programming". + Only serial (1x bus width) is supported, setting the programming mode + is not in the scope the this manager and must be done elsewhere. + + References:Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml line 25
Quoted 10 lines
Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml new file +10
-0+ - https://www.efinixinc.com/docs/an033-configuring-titanium-fpgas-v2.6.pdf + - https://www.efinixinc.com/docs/an006-configuring-trion-fpgas-v6.0.pdf + +allOf: + - $ref: /schemas/spi/spi-peripheral-props.yaml# + +properties: + compatible: + enum: + - efnx,fpga-spi-passiveAhh, here is the user. Can you please add specific compatibles for the Trion and Titanium series FPGAs? And when you do, make the filename match a compatible please.
Quoted 7 lines
Quoted 1 line
Additionally, why "efnx" and not "efinix"?
FWIW, there already is "altr,fpga-passive-serial" for Altera devices.
Not sure why Altera got this short vendor prefix, but that was 2013 with commit
5db17a71a526("of: add vendor prefix for Altera Corp.") and we probably never know?
I think that was the stock ticker name for Altera.
Quoted 7 lines
The method of transferring the configuration data over SPI into the FPGA is comparable. I would go so far to claim a single driver could support both device families for passive configuration over SPI. I've done that in a non-public driver for U-Boot few months ago, and used "efinix,fpga-passive-serial" as a compatible there. The difference is basically Altera requiring more GPIOs considered, and Efinix keeping the SPI clock on for some time after data is already transfered.
That'd prob be helpful to comment on the driver patch. I'd still like to see device specific compatibles here for the trion and titanium though.
Thanks,
Conor.
Rob Herring (Arm)
maintainerQuoted 11 lines · On Thu, 20 Jun 2024 16:44:40 +0200, [email protected] wrote:
From: Ian Dannapel <[email protected]>
Add device tree binding documentation for configuring Efinix FPGA using serial SPI passive programming mode.
Signed-off-by Ian Dannapel <[email protected]>--- .../bindings/fpga/efnx,fpga-passive-spi.yaml | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml
My bot found errors running 'make dt_binding_check' on your patch:
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.yaml: 'maintainers' is a required property
hint: Metaschema for devicetree binding documentation
from schema $id: http://devicetree.org/meta-schemas/base.yaml#
Error: Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.example.dts:18.9-14 syntax error
FATAL ERROR: Unable to parse input tree
make[2]: *** [scripts/Makefile.lib:427: Documentation/devicetree/bindings/fpga/efnx,fpga-passive-spi.example.dtb] Error 1 make[2]: *** Waiting for unfinished jobs....
make[1]: *** [/builds/robherring/dt-review-ci/linux/Makefile:1430: dt_binding_check] Error 2
make: *** [Makefile:240: __sub-make] Error 2
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/[email protected]
The base for the series is generally the latest rc1. A different dependency should be noted in *this* patch.
If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:
pip3 install dtschema --upgrade
Please check and re-submit after running the above command yourself. Note that DT_SCHEMA_FILES can be set to your schema file to speed up checking your schema. However, it must be unset to test all examples with your schema.