[v3] bindings: spi-samsung: document the clocks and the clock-name property

Commit Message

Andi Shyti July 11, 2016, 2:36 a.m. UTC

These two properties were not documented but used in the spi
dts. Add the related documentation.

Suggested-by: Krzysztof Kozlowski <[e-mail]>
Signed-off-by: Andi Shyti <[e-mail]>
Reviewed-by: Michael Turquette <[e-mail]>
Reviewed-by: Krzysztof Kozlowski <[e-mail]>
---
Hi,

Changelog related only to this patch:

V1 -> V2: [new] added the clocks and clock-name documentation
   in the bindings

V2 -> V3: reworded the 'clock-names' as suggested by Krzysztof,
   added Mike's and Krzysztof's review and Krzysztof's
   suggested-by.

Thanks,
Andi

 Documentation/devicetree/bindings/spi/spi-samsung.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

Patch

diff --git a/Documentation/devicetree/bindings/spi/spi-samsung.txt b/Documentation/devicetree/bindings/spi/spi-samsung.txt
index 57d5539..f45c6eb 100644
--- a/Documentation/devicetree/bindings/spi/spi-samsung.txt
+++ b/Documentation/devicetree/bindings/spi/spi-samsung.txt
@@ -24,6 +24,15 @@  Required SoC Specific Properties:
 - dma-names: Names for the dma channels. There must be at least one channel
   named "tx" for transmit and named "rx" for receive.
 
+- clocks: specifies the clock IDs provided to the SPI controller; they are
+  required for interacting with the controller itself, for synchronizing the bus
+  and as I/O clock (the latter is required by exynos5433 and exynos7).
+
+- clock-names: string names of the clocks in the 'clocks' property; for all the
+  the devices the names must be "spi", "spi_busclkN" (where N is determined by
+  "samsung,spi-src-clk"), while Exynos5433 should specify a third clock
+  "spi_ioclk" for the I/O clock.
+
 Required Board Specific Properties:
 
 - #address-cells: should be 1.