ASoC: img: Cleanup documentation

Cleanup the IMG audio controller documentation.

Change-Id: I8b38a99fcdc7305057169b0c433c13a3a44b7411
Signed-off-by: Damien.Horsley <Damien.Horsley@imgtec.com>

6 files changed, 56 insertions, 62 deletions

diff --git a/Documentation/devicetree/bindings/sound/img,i2s-in.txt b/Documentation/devicetree/bindings/sound/img,i2s-in.txt
index 83134c15376..a9e3c862a94 100644
--- a/Documentation/devicetree/bindings/sound/img,i2s-in.txt
+++ b/Documentation/devicetree/bindings/sound/img,i2s-in.txt
@@ -1,6 +1,6 @@
-Imagination Technologies I2S In Controller
+Imagination Technologies I2S Input Controller
 
-Required properties:
+Required Properties:
 
   - compatible : Compatible list, must contain "img,i2s-in"
 
@@ -8,21 +8,15 @@ Required properties:
 
   - reg : Offset and length of the register set for the device
 
-  - clocks : Must contain an entry for each entry in clock-names
-	See ../clock/clock-bindings.txt for details
+  - clocks : Contains an entry for each entry in clock-names
 
-  - clock-names : Must include the following entries:
+  - clock-names : Must include the following entry:
 	"sys"	The system clock
 
-  - dmas: Must contain an entry for each entry in dma-names. Depending on
-	the configuration, there may be one dma used for all active channels,
-	one dma per I2S channel, or both a shared dma and and a dma per I2S
-	channel
-	See ../dma/dma.txt for details
+  - dmas: Contains an entry for each entry in dma-names.
 
-  - dma-names: Must include one or both of the following:
-	"rx"				Shared dma
-	"rxN" for N = 1..i2s-channels	Per-channel dma
+  - dma-names: Must include the following entry:
+	"rx"	Single DMA channel used by all active I2S channels
 
   - img,i2s-channels : Number of I2S channels instantiated in the I2S in block
 
@@ -32,20 +26,20 @@ Optional Properties:
 	the configuration, there may be no interrupts, one interrupt,
 	or an interrupt per I2S channel
 
-  - resets: Should contain a phandle to the I2S in reset signal
+  - resets: Contains a phandle to the I2S in reset signal
 
-  - reset-names: Should contain the reset signal name "rst"
+  - reset-names: Contains the reset signal name "rst"
 
 Example:
 
 i2s_in: i2s-in@18100800 {
 	compatible = "img,i2s-in";
-	#sound-dai-cells = <0>;
 	reg = <0x18100800 0x200>;
 	interrupts = <GIC_SHARED 7 IRQ_TYPE_LEVEL_HIGH>;
 	dmas = <&mdc 30 0xffffffff 0>;
 	dma-names = "rx";
-	clocks = <&system_clk>;
+	clocks = <&cr_periph SYS_CLK_I2S_IN>;
 	clock-names = "sys";
 	img,i2s-channels = <6>;
+	#sound-dai-cells = <0>;
 };
diff --git a/Documentation/devicetree/bindings/sound/img,i2s-out.txt b/Documentation/devicetree/bindings/sound/img,i2s-out.txt
index df91e7b1ac3..dc110ce5f81 100644
--- a/Documentation/devicetree/bindings/sound/img,i2s-out.txt
+++ b/Documentation/devicetree/bindings/sound/img,i2s-out.txt
@@ -1,6 +1,6 @@
-Imagination Technologies I2S Out Controller
+Imagination Technologies I2S Output Controller
 
-Required properties:
+Required Properties:
 
   - compatible : Compatible list, must contain "img,i2s-out"
 
@@ -8,28 +8,22 @@ Required properties:
 
   - reg : Offset and length of the register set for the device
 
-  - clocks : Must contain an entry for each entry in clock-names
-	See ../clock/clock-bindings.txt for details
+  - clocks : Contains an entry for each entry in clock-names
 
   - clock-names : Must include the following entries:
 	"sys"	The system clock
 	"ref"	The reference clock
 
-  - dmas: Must contain an entry for each entry in dma-names. Depending on
-	the configuration, there may be one dma used for all active channels,
-	one dma per I2S channel, or both a shared dma and and a dma per I2S
-	channel
-	See ../dma/dma.txt for details
+  - dmas: Contains an entry for each entry in dma-names.
 
-  - dma-names: Must include one or both of the following:
-	"tx"				Shared dma
-	"txN" for N = 1..i2s-channels	Per-channel dma
+  - dma-names: Must include the following entry:
+	"tx"	Single DMA channel used by all active I2S channels
 
   - img,i2s-channels : Number of I2S channels instantiated in the I2S out block
 
-  - resets: Must contain a phandle to the I2S out reset signal
+  - resets: Contains a phandle to the I2S out reset signal
 
-  - reset-names: Must contain the reset signal name "rst"
+  - reset-names: Contains the reset signal name "rst"
 
 Optional Properties:
 
@@ -41,14 +35,15 @@ Example:
 
 i2s_out: i2s-out@18100A00 {
 	compatible = "img,i2s-out";
-	#sound-dai-cells = <0>;
 	reg = <0x18100A00 0x200>;
 	interrupts = <GIC_SHARED 13 IRQ_TYPE_LEVEL_HIGH>;
 	dmas = <&mdc 23 0xffffffff 0>;
 	dma-names = "tx";
-	clocks = <&system_clk>, <&clk_audio>;
+	clocks = <&cr_periph SYS_CLK_I2S_OUT>,
+		 <&clk_core CLK_I2S>;
 	clock-names = "sys", "ref";
 	img,i2s-channels = <6>;
 	resets = <&pistachio_reset PISTACHIO_RESET_I2S_OUT>;
 	reset-names = "rst";
+	#sound-dai-cells = <0>;
 };
diff --git a/Documentation/devicetree/bindings/sound/img,parallel-out.txt b/Documentation/devicetree/bindings/sound/img,parallel-out.txt
index ca87bcd7806..a3015d2a06e 100644
--- a/Documentation/devicetree/bindings/sound/img,parallel-out.txt
+++ b/Documentation/devicetree/bindings/sound/img,parallel-out.txt
@@ -1,6 +1,6 @@
-Imagination Technologies Parallel Out Controller
+Imagination Technologies Parallel Output Controller
 
-Required properties:
+Required Properties:
 
   - compatible : Compatible list, must contain "img,parallel-out".
 
@@ -8,10 +8,10 @@ Required properties:
 
   - reg : Offset and length of the register set for the device.
 
-  - dmas : Generic dma devicetree binding as described in
-  Documentation/devicetree/bindings/dma/dma.txt.
+  - dmas: Contains an entry for each entry in dma-names.
 
-  - dma-names : Includes "tx".
+  - dma-names: Must include the following entry:
+	"tx"
 
   - clocks : Contains an entry for each entry in clock-names.
 
@@ -19,9 +19,9 @@ Required properties:
 	"sys"	The system clock
 	"ref"	The reference clock
 
-  - resets: Must contain a phandle to the parallel out reset signal
+  - resets: Contains a phandle to the parallel out reset signal
 
-  - reset-names: Must contain the reset signal name "rst"
+  - reset-names: Contains the reset signal name "rst"
 
 Optional Properties:
 
@@ -31,13 +31,14 @@ Example:
 
 parallel_out: parallel-out@18100C00 {
 	compatible = "img,parallel-out";
-	#sound-dai-cells = <0>;
 	reg = <0x18100C00 0x100>;
 	interrupts = <GIC_SHARED 19 IRQ_TYPE_LEVEL_HIGH>;
 	dmas = <&mdc 16 0xffffffff 0>;
 	dma-names = "tx";
-	clocks = <&system_clk>, <&clk_audio>;
+	clocks = <&cr_periph SYS_CLK_PAUD_OUT>,
+		 <&clk_core CLK_AUDIO_DAC>;
 	clock-names = "sys", "ref";
 	resets = <&pistachio_reset PISTACHIO_RESET_PRL_OUT>;
 	reset-names = "rst";
+	#sound-dai-cells = <0>;
 };
diff --git a/Documentation/devicetree/bindings/sound/img,spdif-in.txt b/Documentation/devicetree/bindings/sound/img,spdif-in.txt
index 783f6735e20..aab9a81f7e1 100644
--- a/Documentation/devicetree/bindings/sound/img,spdif-in.txt
+++ b/Documentation/devicetree/bindings/sound/img,spdif-in.txt
@@ -1,6 +1,6 @@
-Imagination Technologies SPDIF In Controller
+Imagination Technologies SPDIF Input Controller
 
-Required properties:
+Required Properties:
 
   - compatible : Compatible list, must contain "img,spdif-in"
 
@@ -8,10 +8,10 @@ Required properties:
 
   - reg : Offset and length of the register set for the device
 
-  - dmas : Generic dma devicetree binding as described in
-  Documentation/devicetree/bindings/dma/dma.txt
+  - dmas: Contains an entry for each entry in dma-names.
 
-  - dma-names : Includes "rx"
+  - dma-names: Must include the following entry:
+	"rx"
 
   - clocks : Contains an entry for each entry in clock-names
 
@@ -31,11 +31,11 @@ Example:
 
 spdif_in: spdif-in@18100E00 {
 	compatible = "img,spdif-in";
-	#sound-dai-cells = <0>;
 	reg = <0x18100E00 0x100>;
 	interrupts = <GIC_SHARED 20 IRQ_TYPE_LEVEL_HIGH>;
 	dmas = <&mdc 15 0xffffffff 0>;
 	dma-names = "rx";
-	clocks = <&system_clk>;
+	clocks = <&cr_periph SYS_CLK_SPDIF_IN>;
 	clock-names = "sys";
+	#sound-dai-cells = <0>;
 };
diff --git a/Documentation/devicetree/bindings/sound/img,spdif-out.txt b/Documentation/devicetree/bindings/sound/img,spdif-out.txt
index d6c61b16cbc..470a5191e10 100644
--- a/Documentation/devicetree/bindings/sound/img,spdif-out.txt
+++ b/Documentation/devicetree/bindings/sound/img,spdif-out.txt
@@ -1,6 +1,6 @@
-Imagination Technologies SPDIF Out Controller
+Imagination Technologies SPDIF Output Controller
 
-Required properties:
+Required Properties:
 
   - compatible : Compatible list, must contain "img,spdif-out"
 
@@ -8,34 +8,37 @@ Required properties:
 
   - reg : Offset and length of the register set for the device
 
-  - interrupts : Contains the spdif out interrupt
+  - dmas: Contains an entry for each entry in dma-names.
 
-  - dmas : Generic dma devicetree binding as described in
-           Documentation/devicetree/bindings/dma/dma.txt
+  - dma-names: Must include the following entry:
+	"tx"
 
-  - dma-names : Includes "tx"
-
-  - clocks : Contains an entry for each entry in clock-names
+  - clocks : Contains an entry for each entry in clock-names.
 
   - clock-names : Includes the following entries:
 	"sys"	The system clock
 	"ref"	The reference clock
 
-  - resets: Must contain a phandle to the spdif out reset signal
+  - resets: Contains a phandle to the spdif out reset signal
+
+  - reset-names: Contains the reset signal name "rst"
+
+Optional Properties:
 
-  - reset-names: Must contain the reset signal name "rst"
+  - interrupts : Contains the parallel out interrupt, if present
 
 Example:
 
 spdif_out: spdif-out@18100D00 {
 	compatible = "img,spdif-out";
-	#sound-dai-cells = <0>;
 	reg = <0x18100D00 0x100>;
 	interrupts = <GIC_SHARED 21 IRQ_TYPE_LEVEL_HIGH>;
 	dmas = <&mdc 14 0xffffffff 0>;
 	dma-names = "tx";
-	clocks = <&system_clk>, <&clk_audio>;
+	clocks = <&cr_periph SYS_CLK_SPDIF_OUT>,
+		 <&clk_core CLK_SPDIF>;
 	clock-names = "sys", "ref";
 	resets = <&pistachio_reset PISTACHIO_RESET_SPDIF_OUT>;
 	reset-names = "rst";
+	#sound-dai-cells = <0>;
 };
diff --git a/Documentation/devicetree/bindings/sound/ti,pcm3060.txt b/Documentation/devicetree/bindings/sound/ti,pcm3060.txt
index 31dfeabbf40..d0a0b1317a4 100644
--- a/Documentation/devicetree/bindings/sound/ti,pcm3060.txt
+++ b/Documentation/devicetree/bindings/sound/ti,pcm3060.txt
@@ -27,7 +27,8 @@ i2c0: i2c0@0 {
 	pcm3060: audio-codec@46 {
 		compatible = "ti,pcm3060";
 		reg = <0x46>;
-		clocks = <&clk_core CLK_I2S &clk_core CLK_I2S>;
+		clocks = <&clk_core CLK_I2S>,
+			 <&clk_core CLK_I2S>;
 		clock-names = "sckid", "sckia";
 		VCC-supply = <&supply5v0>;
 		VDD-supply = <&supply3v3>;