diff options
author | Nicolin Chen <nicoleotsuka@gmail.com> | 2014-10-07 15:29:06 -0400 |
---|---|---|
committer | Mark Brown <broonie@kernel.org> | 2014-10-20 07:20:20 -0400 |
commit | 0b9938b264d1a76458cf06aab6de7b9cec68efca (patch) | |
tree | f176edce389384c9b9224af7cd10e723fb131c50 | |
parent | 9c4c1045343836b848c3dd546277c955d145d20a (diff) |
ASoC: fsl_sai: Add indentation for binding doc to increase readability
This patch refines the DT binding doc for more readability by adding
extra blank lines and indentations.
Signed-off-by: Nicolin Chen <nicoleotsuka@gmail.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
-rw-r--r-- | Documentation/devicetree/bindings/sound/fsl-sai.txt | 66 |
1 files changed, 41 insertions, 25 deletions
diff --git a/Documentation/devicetree/bindings/sound/fsl-sai.txt b/Documentation/devicetree/bindings/sound/fsl-sai.txt index 4956b14d4b06..044e5d76e2dd 100644 --- a/Documentation/devicetree/bindings/sound/fsl-sai.txt +++ b/Documentation/devicetree/bindings/sound/fsl-sai.txt | |||
@@ -5,32 +5,48 @@ which provides a synchronous audio interface that supports fullduplex | |||
5 | serial interfaces with frame synchronization such as I2S, AC97, TDM, and | 5 | serial interfaces with frame synchronization such as I2S, AC97, TDM, and |
6 | codec/DSP interfaces. | 6 | codec/DSP interfaces. |
7 | 7 | ||
8 | |||
9 | Required properties: | 8 | Required properties: |
10 | - compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai". | 9 | |
11 | - reg: Offset and length of the register set for the device. | 10 | - compatible : Compatible list, contains "fsl,vf610-sai" or |
12 | - clocks: Must contain an entry for each entry in clock-names. | 11 | "fsl,imx6sx-sai". |
13 | - clock-names : Must include the "bus" for register access and "mclk1" "mclk2" | 12 | |
14 | "mclk3" for bit clock and frame clock providing. | 13 | - reg : Offset and length of the register set for the device. |
15 | - dmas : Generic dma devicetree binding as described in | 14 | |
16 | Documentation/devicetree/bindings/dma/dma.txt. | 15 | - clocks : Must contain an entry for each entry in clock-names. |
17 | - dma-names : Two dmas have to be defined, "tx" and "rx". | 16 | |
18 | - pinctrl-names: Must contain a "default" entry. | 17 | - clock-names : Must include the "bus" for register access and |
19 | - pinctrl-NNN: One property must exist for each entry in pinctrl-names. | 18 | "mclk1", "mclk2", "mclk3" for bit clock and frame |
20 | See ../pinctrl/pinctrl-bindings.txt for details of the property values. | 19 | clock providing. |
21 | - big-endian: Boolean property, required if all the FTM_PWM registers | 20 | - dmas : Generic dma devicetree binding as described in |
22 | are big-endian rather than little-endian. | 21 | Documentation/devicetree/bindings/dma/dma.txt. |
23 | - lsb-first: Configures whether the LSB or the MSB is transmitted first for | 22 | |
24 | the fifo data. If this property is absent, the MSB is transmitted first as | 23 | - dma-names : Two dmas have to be defined, "tx" and "rx". |
25 | default, or the LSB is transmitted first. | 24 | |
26 | - fsl,sai-synchronous-rx: This is a boolean property. If present, indicating | 25 | - pinctrl-names : Must contain a "default" entry. |
27 | that SAI will work in the synchronous mode (sync Tx with Rx) which means | 26 | |
28 | both the transimitter and receiver will send and receive data by following | 27 | - pinctrl-NNN : One property must exist for each entry in |
29 | receiver's bit clocks and frame sync clocks. | 28 | pinctrl-names. See ../pinctrl/pinctrl-bindings.txt |
30 | - fsl,sai-asynchronous: This is a boolean property. If present, indicating | 29 | for details of the property values. |
31 | that SAI will work in the asynchronous mode, which means both transimitter | 30 | |
32 | and receiver will send and receive data by following their own bit clocks | 31 | - big-endian : Boolean property, required if all the FTM_PWM |
33 | and frame sync clocks separately. | 32 | registers are big-endian rather than little-endian. |
33 | |||
34 | - lsb-first : Configures whether the LSB or the MSB is transmitted | ||
35 | first for the fifo data. If this property is absent, | ||
36 | the MSB is transmitted first as default, or the LSB | ||
37 | is transmitted first. | ||
38 | |||
39 | - fsl,sai-synchronous-rx: This is a boolean property. If present, indicating | ||
40 | that SAI will work in the synchronous mode (sync Tx | ||
41 | with Rx) which means both the transimitter and the | ||
42 | receiver will send and receive data by following | ||
43 | receiver's bit clocks and frame sync clocks. | ||
44 | |||
45 | - fsl,sai-asynchronous: This is a boolean property. If present, indicating | ||
46 | that SAI will work in the asynchronous mode, which | ||
47 | means both transimitter and receiver will send and | ||
48 | receive data by following their own bit clocks and | ||
49 | frame sync clocks separately. | ||
34 | 50 | ||
35 | Note: | 51 | Note: |
36 | - If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the | 52 | - If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the |