Add the documentation for dt-binding of the digital audio codec driver
for sun8i SoC.

Signed-off-by: Mylène Josserand <mylene.josser...@free-electrons.com>
---
 .../devicetree/bindings/sound/sun8i-codec.txt      | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/sun8i-codec.txt

diff --git a/Documentation/devicetree/bindings/sound/sun8i-codec.txt 
b/Documentation/devicetree/bindings/sound/sun8i-codec.txt
new file mode 100644
index 0000000..1808869
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/sun8i-codec.txt
@@ -0,0 +1,24 @@
+* Allwinner A23/A33 Codec
+
+Required properties:
+- compatible: must be either "allwinner,sun4i-a23-codec" or
+  "allwinner,sun7i-a33-codec"
+- reg: must contain the registers location and length
+- interrupts: must contain the codec interrupt
+- clocks: a list of phandle + clock-specifer pairs, one for each entry
+  in clock-names.
+- clock-names: should contain followings:
+   - "apb": the parent APB clock for this controller
+   - "codec": the parent module clock
+
+Example:
+codec: codec@01c22e00 {
+       #sound-dai-cells = <0>;
+       compatible = "allwinner,sun8i-a33-codec";
+       reg = <0x01c22e00 0x400>; /* SUNXI_AUDIO_PBASE + 0x200 */
+       reg-names = "audio";
+       interrupts = <GIC_SPI 29 IRQ_TYPE_LEVEL_HIGH>;
+       clocks = <&ccu CLK_BUS_CODEC>, <&ccu CLK_AC_DIG>;
+       clock-names = "apb", "codec";
+       status = "disabled";
+};
-- 
2.9.3

Reply via email to