Commit 0b9938b2 authored by Nicolin Chen's avatar Nicolin Chen Committed by Mark Brown

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: default avatarNicolin Chen <nicoleotsuka@gmail.com>
Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 9c4c1045
...@@ -5,32 +5,48 @@ which provides a synchronous audio interface that supports fullduplex ...@@ -5,32 +5,48 @@ which provides a synchronous audio interface that supports fullduplex
serial interfaces with frame synchronization such as I2S, AC97, TDM, and serial interfaces with frame synchronization such as I2S, AC97, TDM, and
codec/DSP interfaces. codec/DSP interfaces.
Required properties: Required properties:
- compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai".
- reg: Offset and length of the register set for the device. - compatible : Compatible list, contains "fsl,vf610-sai" or
- clocks: Must contain an entry for each entry in clock-names. "fsl,imx6sx-sai".
- clock-names : Must include the "bus" for register access and "mclk1" "mclk2"
"mclk3" for bit clock and frame clock providing. - reg : Offset and length of the register set for the device.
- dmas : Generic dma devicetree binding as described in
- clocks : Must contain an entry for each entry in clock-names.
- clock-names : Must include the "bus" for register access and
"mclk1", "mclk2", "mclk3" for bit clock and frame
clock providing.
- dmas : Generic dma devicetree binding as described in
Documentation/devicetree/bindings/dma/dma.txt. Documentation/devicetree/bindings/dma/dma.txt.
- dma-names : Two dmas have to be defined, "tx" and "rx".
- pinctrl-names: Must contain a "default" entry. - dma-names : Two dmas have to be defined, "tx" and "rx".
- pinctrl-NNN: One property must exist for each entry in pinctrl-names.
See ../pinctrl/pinctrl-bindings.txt for details of the property values. - pinctrl-names : Must contain a "default" entry.
- big-endian: Boolean property, required if all the FTM_PWM registers
are big-endian rather than little-endian. - pinctrl-NNN : One property must exist for each entry in
- lsb-first: Configures whether the LSB or the MSB is transmitted first for pinctrl-names. See ../pinctrl/pinctrl-bindings.txt
the fifo data. If this property is absent, the MSB is transmitted first as for details of the property values.
default, or the LSB is transmitted first.
- fsl,sai-synchronous-rx: This is a boolean property. If present, indicating - big-endian : Boolean property, required if all the FTM_PWM
that SAI will work in the synchronous mode (sync Tx with Rx) which means registers are big-endian rather than little-endian.
both the transimitter and receiver will send and receive data by following
- lsb-first : Configures whether the LSB or the MSB is transmitted
first for the fifo data. If this property is absent,
the MSB is transmitted first as default, or the LSB
is transmitted first.
- fsl,sai-synchronous-rx: This is a boolean property. If present, indicating
that SAI will work in the synchronous mode (sync Tx
with Rx) which means both the transimitter and the
receiver will send and receive data by following
receiver's bit clocks and frame sync clocks. receiver's bit clocks and frame sync clocks.
- fsl,sai-asynchronous: This is a boolean property. If present, indicating
that SAI will work in the asynchronous mode, which means both transimitter - fsl,sai-asynchronous: This is a boolean property. If present, indicating
and receiver will send and receive data by following their own bit clocks that SAI will work in the asynchronous mode, which
and frame sync clocks separately. means both transimitter and receiver will send and
receive data by following their own bit clocks and
frame sync clocks separately.
Note: Note:
- If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the - If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment