OSDN Git Service

spi: axi: Add bindings documentation for Analog Devices axi-spi-engine
authorLars-Peter Clausen <lars@metafoo.de>
Thu, 4 Feb 2016 16:13:29 +0000 (17:13 +0100)
committerMark Brown <broonie@kernel.org>
Fri, 5 Feb 2016 18:12:47 +0000 (18:12 +0000)
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>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/spi/adi,axi-spi-engine.txt [new file with mode: 0644]

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 (file)
index 0000000..8a18d71
--- /dev/null
@@ -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 */
+    };