dt-bindings: sound: omap-mcpdm: Update documentation for pdmclk
authorPeter Ujfalusi <peter.ujfalusi@ti.com>
Wed, 14 Nov 2018 12:46:30 +0000 (14:46 +0200)
committerMark Brown <broonie@kernel.org>
Wed, 28 Nov 2018 15:19:31 +0000 (15:19 +0000)
McPDM module receives it's functional clock from external source. This
clock is the pdmclk provided by the twl6040 audio IC. If the clock is not
available all register accesses to McPDM fails and the module is not
operational.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/omap-mcpdm.txt

index 5f4e68c..ff98a0c 100644 (file)
@@ -7,6 +7,8 @@ Required properties:
        <L3 interconnect address, size>;
 - interrupts: Interrupt number for McPDM
 - ti,hwmods: Name of the hwmod associated to the McPDM
+- clocks:  phandle for the pdmclk provider, likely <&twl6040>
+- clock-names: Must be "pdmclk"
 
 Example:
 
@@ -18,3 +20,11 @@ mcpdm: mcpdm@40132000 {
        interrupt-parent = <&gic>;
        ti,hwmods = "mcpdm";
 };
+
+In board DTS file the pdmclk needs to be added:
+
+&mcpdm {
+       clocks = <&twl6040>;
+       clock-names = "pdmclk";
+       status = "okay";
+};