[PATCH 2/3] Document: fsl,esai: Adjust the document making it read more comfortably.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




Signed-off-by: Xiubo Li <Li.Xiubo@xxxxxxxxxxxxx>
Cc: Varka Bhadram <varkabhadram@xxxxxxxxx>
---
 .../devicetree/bindings/sound/fsl,esai.txt         | 73 ++++++++++++----------
 1 file changed, 39 insertions(+), 34 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/fsl,esai.txt b/Documentation/devicetree/bindings/sound/fsl,esai.txt
index aeb8c4a..4dce656 100644
--- a/Documentation/devicetree/bindings/sound/fsl,esai.txt
+++ b/Documentation/devicetree/bindings/sound/fsl,esai.txt
@@ -7,49 +7,54 @@ other DSPs. It has up to six transmitters and four receivers.
 
 Required properties:
 
-  - compatible : Compatible list, must contain "fsl,imx35-esai".
+- compatible:	Compatible list, must contain "fsl,imx35-esai".
 
-  - reg : Offset and length of the register set for the device.
+- reg:		Offset and length of the register set for the device.
 
-  - interrupts : Contains the spdif interrupt.
+- interrupts:	Contains the spdif interrupt.
 
-  - dmas : Generic dma devicetree binding as described in
-  Documentation/devicetree/bindings/dma/dma.txt.
+- dmas:		Generic dma devicetree binding as described in
+		Documentation/devicetree/bindings/dma/dma.txt.
 
-  - dma-names : Two dmas have to be defined, "tx" and "rx".
+- dma-names:	Two dmas have to be defined, "tx" and "rx".
 
-  - 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:
-	"core"		The core clock used to access registers
-	"extal"		The esai baud clock for esai controller used to derive
-			HCK, SCK and FS.
-	"fsys"		The system clock derived from ahb clock used to derive
-			HCK, SCK and FS.
+- clock-names:	Includes the following entries:
+		"core" -- The core clock used to access registers
+		"extal"-- The esai baud clock for esai controller used to
+		derive HCK, SCK and FS.
+		"fsys" -- The system clock derived from ahb clock used to
+		derive HCK, SCK and FS.
 
-  - fsl,fifo-depth: The number of elements in the transmit and receive FIFOs.
-    This number is the maximum allowed value for TFCR[TFWM] or RFCR[RFWM].
+- fsl,fifo-depth:
+		The number of elements in the transmit and receive FIFOs.
+		This number is the maximum allowed value for TFCR[TFWM] or
+		RFCR[RFWM].
 
-  - fsl,esai-synchronous: This is a boolean property. If present, indicating
-    that ESAI would work in the synchronous mode, which means all the settings
-    for Receiving would be duplicated from Transmition related registers.
+- fsl,esai-synchronous:
+		This is a boolean property. If present, indicating that ESAI
+		would work in the synchronous mode, which means all the settings
+		for Receiving would be duplicated from Transmition related
+		registers.
 
-  - big-endian : If this property is absent, the native endian mode will
-    be in use as default, or the big endian mode will be in use for all the
-    device registers.
+- big-endian:
+		If this property is absent, the native endian mode will be in
+		use as default, or the big endian mode will be in use for all the
+		device registers.
 
 Example:
 
-esai: esai@02024000 {
-	compatible = "fsl,imx35-esai";
-	reg = <0x02024000 0x4000>;
-	interrupts = <0 51 0x04>;
-	clocks = <&clks 208>, <&clks 118>, <&clks 208>;
-	clock-names = "core", "extal", "fsys";
-	dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
-	dma-names = "rx", "tx";
-	fsl,fifo-depth = <128>;
-	fsl,esai-synchronous;
-	big-endian;
-	status = "disabled";
-};
+	esai: esai@02024000 {
+		compatible = "fsl,imx35-esai";
+		reg = <0x02024000 0x4000>;
+		interrupts = <0 51 0x04>;
+		clocks = <&clks 208>, <&clks 118>, <&clks 208>;
+		clock-names = "core", "extal", "fsys";
+		dmas = <&sdma 23 21 0>, <&sdma 24 21 0>;
+		dma-names = "rx", "tx";
+		fsl,fifo-depth = <128>;
+		fsl,esai-synchronous;
+		big-endian;
+		status = "disabled";
+	};
-- 
1.8.5

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Device Tree Compilter]     [Device Tree Spec]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux PCI Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]
  Powered by Linux