[1/2] dt: bindings: fpga: add xilinx slave-serial binding description

Commit Message

Anatolij Gustschin Feb. 16, 2017, 3:10 p.m. UTC

Add dt binding documentation details for Xilinx FPGA configuration
over slave serial interface.

Signed-off-by: Anatolij Gustschin <[e-mail]>
---
 .../bindings/fpga/xilinx-slave-serial.txt          | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt

Comments

Joshua Clayton Feb. 16, 2017, 5:24 p.m. UTC | #1

On 02/16/2017 07:10 AM, Anatolij Gustschin wrote:
> Add dt binding documentation details for Xilinx FPGA configuration
> over slave serial interface.
>
> Signed-off-by: Anatolij Gustschin <[e-mail]>
> ---
>  .../bindings/fpga/xilinx-slave-serial.txt          | 24 ++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
>
> diff --git a/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
> new file mode 100644
> index 0000000..b5fa6a6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
> @@ -0,0 +1,24 @@
> +Xilinx Slave Serial SPI FPGA Manager
> +
> +Xilinx Spartan-6 FPGAs support a method of loading the bitstream over
> +what is referred to as "slave serial" interface.
> +The slave 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.xilinx.com/support/documentation/user_guides/ug380.pdf
> +
> +Required properties:
> +- compatible: should contain "xlnx,fpga-slave-serial"
> +- reg: spi chip select of the FPGA
> +- prog_b-gpios: config pin (referred to as PROGRAM_B in the manual)
> +- done-gpios: config status pin (referred to as DONE in the manual)
> +
> +Example:
> +	fpga_mgr_spi: fpga-spi@0 {
> +		compatible = "xlnx,fpga-slave-serial";
> +		spi-max-frequency = <60000000>;
> +		spi-cpha;
> +		reg = <0>;
> +		done-gpio = <&gpio0 9 GPIO_ACTIVE_HIGH>;
> +		prog_b-gpio = <&gpio0 29 GPIO_ACTIVE_LOW>;
> +	};
nit: you've put prog_b-gpios and done-gpios in the description,
but the example still has "prog_b-gpio" and "done-gpio"
--
To unsubscribe from this list: send the line "unsubscribe linux-fpga" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Moritz Fischer Feb. 16, 2017, 5:36 p.m. UTC | #2

Hi Anatolij,

On Thu, Feb 16, 2017 at 7:10 AM, Anatolij Gustschin <[e-mail]> wrote:
> Add dt binding documentation details for Xilinx FPGA configuration
> over slave serial interface.
>
> Signed-off-by: Anatolij Gustschin <[e-mail]>
> ---
>  .../bindings/fpga/xilinx-slave-serial.txt          | 24 ++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
>
> diff --git a/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
> new file mode 100644
> index 0000000..b5fa6a6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
> @@ -0,0 +1,24 @@
> +Xilinx Slave Serial SPI FPGA Manager
> +
> +Xilinx Spartan-6 FPGAs support a method of loading the bitstream over
> +what is referred to as "slave serial" interface.
> +The slave 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.xilinx.com/support/documentation/user_guides/ug380.pdf
> +
> +Required properties:
> +- compatible: should contain "xlnx,fpga-slave-serial"
> +- reg: spi chip select of the FPGA
> +- prog_b-gpios: config pin (referred to as PROGRAM_B in the manual)
> +- done-gpios: config status pin (referred to as DONE in the manual)
> +
> +Example:
> +       fpga_mgr_spi: fpga-spi@0 {

Maybe we can standardize them here to be fpga-mgr@X, that being said,
I don't do what I suggested in the zynq fpga mgr bindings docs.

> +               compatible = "xlnx,fpga-slave-serial";
> +               spi-max-frequency = <60000000>;
> +               spi-cpha;
> +               reg = <0>;
> +               done-gpio = <&gpio0 9 GPIO_ACTIVE_HIGH>;
> +               prog_b-gpio = <&gpio0 29 GPIO_ACTIVE_LOW>;
> +       };
> --
> 1.9.1
>

Thanks,

Moritz
--
To unsubscribe from this list: send the line "unsubscribe linux-fpga" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Anatolij Gustschin Feb. 16, 2017, 6:51 p.m. UTC | #3

Hi Joshua,

On Thu, 16 Feb 2017 09:24:09 -0800
Joshua Clayton [e-mail] wrote:
...
>> +	fpga_mgr_spi: fpga-spi@0 {
>> +		compatible = "xlnx,fpga-slave-serial";
>> +		spi-max-frequency = <60000000>;
>> +		spi-cpha;
>> +		reg = <0>;
>> +		done-gpio = <&gpio0 9 GPIO_ACTIVE_HIGH>;
>> +		prog_b-gpio = <&gpio0 29 GPIO_ACTIVE_LOW>;
>> +	};  
>nit: you've put prog_b-gpios and done-gpios in the description,
>but the example still has "prog_b-gpio" and "done-gpio"

Thanks for catching that! I copy pasted them from my testing .dts
but now I see that gpio suffix is deprecated for new gpio bindings.
Will fix the example in next patch version.

Thanks,
Anatolij
--
To unsubscribe from this list: send the line "unsubscribe linux-fpga" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Anatolij Gustschin Feb. 16, 2017, 6:54 p.m. UTC | #4

Hi Moritz,

On Thu, 16 Feb 2017 09:36:08 -0800
Moritz Fischer [e-mail] wrote:
...
>> +Example:
>> +       fpga_mgr_spi: fpga-spi@0 {  
>
>Maybe we can standardize them here to be fpga-mgr@X, that being said,
>I don't do what I suggested in the zynq fpga mgr bindings docs.

Yes, I can use fpga-mgr@X if that is preferred.

Thanks,
Anatolij
--
To unsubscribe from this list: send the line "unsubscribe linux-fpga" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
new file mode 100644
index 0000000..b5fa6a6
--- /dev/null
+++ b/Documentation/devicetree/bindings/fpga/xilinx-slave-serial.txt
@@ -0,0 +1,24 @@ 
+Xilinx Slave Serial SPI FPGA Manager
+
+Xilinx Spartan-6 FPGAs support a method of loading the bitstream over
+what is referred to as "slave serial" interface.
+The slave 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.xilinx.com/support/documentation/user_guides/ug380.pdf
+
+Required properties:
+- compatible: should contain "xlnx,fpga-slave-serial"
+- reg: spi chip select of the FPGA
+- prog_b-gpios: config pin (referred to as PROGRAM_B in the manual)
+- done-gpios: config status pin (referred to as DONE in the manual)
+
+Example:
+	fpga_mgr_spi: fpga-spi@0 {
+		compatible = "xlnx,fpga-slave-serial";
+		spi-max-frequency = <60000000>;
+		spi-cpha;
+		reg = <0>;
+		done-gpio = <&gpio0 9 GPIO_ACTIVE_HIGH>;
+		prog_b-gpio = <&gpio0 29 GPIO_ACTIVE_LOW>;
+	};