diff mbox

[1/2] devicetree: Add bindings documentation for Analog Devices axi-spi-engine

Message ID 1454602410-14049-1-git-send-email-lars@metafoo.de (mailing list archive)
State Accepted
Commit 2ec3b6287b12a7131c28cd9408b368cd451bdc48
Headers show

Commit Message

Lars-Peter Clausen Feb. 4, 2016, 4:13 p.m. UTC
Add the devicetree bindings documentation for the Analog Devices
axi-spi-engine SPI master peripheral. This is a soft-peripheral used in
FPGAs.

The external interfaces of the peripheral are:
	* A memory mapped register map which is used to configure the
	  peripheral.
	* One interrupt.
	* Two clocks, one for the memory mapped register interface and one
	  for the SPI bus.
	* A SPI master interface to which the slave devices are connected.

These interfaces are described by the devicetree bindings accordingly.

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
---
 .../devicetree/bindings/spi/adi,axi-spi-engine.txt | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt

Comments

Rob Herring Feb. 8, 2016, 6:59 p.m. UTC | #1
On Thu, Feb 04, 2016 at 05:13:29PM +0100, Lars-Peter Clausen wrote:
> Add the devicetree bindings documentation for the Analog Devices
> axi-spi-engine SPI master peripheral. This is a soft-peripheral used in
> FPGAs.
> 
> The external interfaces of the peripheral are:
> 	* A memory mapped register map which is used to configure the
> 	  peripheral.
> 	* One interrupt.
> 	* Two clocks, one for the memory mapped register interface and one
> 	  for the SPI bus.
> 	* A SPI master interface to which the slave devices are connected.
> 
> These interfaces are described by the devicetree bindings accordingly.
> 
> Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
> ---
>  .../devicetree/bindings/spi/adi,axi-spi-engine.txt | 31 ++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt

Acked-by: Rob Herring <robh@kernel.org>

> 
> diff --git a/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt b/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt
> new file mode 100644
> index 0000000..8a18d71
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt
> @@ -0,0 +1,31 @@
> +Analog Devices AXI SPI Engine controller Device Tree Bindings
> +
> +Required properties:
> +- compatible		: Must be "adi,axi-spi-engine-1.00.a""
> +- reg			: Physical base address and size of the register map.
> +- interrupts		: Property with a value describing the interrupt
> +			  number.
> +- clock-names		: List of input clock names - "s_axi_aclk", "spi_clk"
> +- clocks		: Clock phandles and specifiers (See clock bindings for
> +			  details on clock-names and clocks).
> +- #address-cells	: Must be <1>
> +- #size-cells		: Must be <0>
> +
> +Optional subnodes:
> +	Subnodes are use to represent the SPI slave devices connected to the SPI
> +	master. They follow the generic SPI bindings as outlined in spi-bus.txt.
> +
> +Example:
> +
> +    spi@@44a00000 {
> +		compatible = "adi,axi-spi-engine-1.00.a";
> +		reg = <0x44a00000 0x1000>;
> +		interrupts = <0 56 4>;
> +		clocks = <&clkc 15 &clkc 15>;
> +		clock-names = "s_axi_aclk", "spi_clk";
> +
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +
> +		/* SPI devices */
> +    };
> -- 
> 2.1.4
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-spi" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt b/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt
new file mode 100644
index 0000000..8a18d71
--- /dev/null
+++ b/Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt
@@ -0,0 +1,31 @@ 
+Analog Devices AXI SPI Engine controller Device Tree Bindings
+
+Required properties:
+- compatible		: Must be "adi,axi-spi-engine-1.00.a""
+- reg			: Physical base address and size of the register map.
+- interrupts		: Property with a value describing the interrupt
+			  number.
+- clock-names		: List of input clock names - "s_axi_aclk", "spi_clk"
+- clocks		: Clock phandles and specifiers (See clock bindings for
+			  details on clock-names and clocks).
+- #address-cells	: Must be <1>
+- #size-cells		: Must be <0>
+
+Optional subnodes:
+	Subnodes are use to represent the SPI slave devices connected to the SPI
+	master. They follow the generic SPI bindings as outlined in spi-bus.txt.
+
+Example:
+
+    spi@@44a00000 {
+		compatible = "adi,axi-spi-engine-1.00.a";
+		reg = <0x44a00000 0x1000>;
+		interrupts = <0 56 4>;
+		clocks = <&clkc 15 &clkc 15>;
+		clock-names = "s_axi_aclk", "spi_clk";
+
+		#address-cells = <1>;
+		#size-cells = <0>;
+
+		/* SPI devices */
+    };