spi/bcm63xx-hsspi: document bcm63xx HS SPI devicetree bindings
authorJonas Gorski <jonas.gorski@gmail.com>
Wed, 1 Mar 2017 09:08:13 +0000 (10:08 +0100)
committerMark Brown <broonie@kernel.org>
Mon, 13 Mar 2017 15:51:45 +0000 (15:51 +0000)
Add documentation for the bindings of the high speed SPI controller found
on newer bcm63xx SoCs.

Signed-off-by: Jonas Gorski <jonas.gorski@gmail.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt b/Documentation/devicetree/bindings/spi/spi-bcm63xx-hsspi.txt
new file mode 100644 (file)
index 0000000..37b29ee
--- /dev/null
@@ -0,0 +1,33 @@
+Binding for Broadcom BCM6328 High Speed SPI controller
+
+Required properties:
+- compatible: must contain of "brcm,bcm6328-hsspi".
+- reg: Base address and size of the controllers memory area.
+- interrupts: Interrupt for the SPI block.
+- clocks: phandles of the SPI clock and the PLL clock.
+- clock-names: must be "hsspi", "pll".
+- #address-cells: <1>, as required by generic SPI binding.
+- #size-cells: <0>, also as required by generic SPI binding.
+
+Optional properties:
+- num-cs: some controllers have less than 8 cs signals. Defaults to 8
+  if absent.
+
+Child nodes as per the generic SPI binding.
+
+Example:
+
+       spi@10001000 {
+               compatible = "brcm,bcm6328-hsspi";
+               reg = <0x10001000 0x600>;
+
+               interrupts = <29>;
+
+               clocks = <&clkctl 9>, <&hsspi_pll>;
+               clock-names = "hsspi", "pll";
+
+               num-cs = <2>;
+
+               #address-cells = <1>;
+               #size-cells = <0>;
+       };