Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

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

Documentation/devicetree/bindings/sound/fsl-sai.txt

+41 −25
Original line number Diff line number Diff line
@@ -5,32 +5,48 @@ which provides a synchronous audio interface that supports fullduplex 
serial interfaces with frame synchronization such as I2S, AC97, TDM, and

codec/DSP interfaces.





Required properties:

- compatible: Compatible list, contains "fsl,vf610-sai" or "fsl,imx6sx-sai".



  - compatible		: Compatible list, contains "fsl,vf610-sai" or

			  "fsl,imx6sx-sai".



  - reg			: Offset and length of the register set for the device.



  - 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.



  - 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.



  - dma-names		: Two dmas have to be defined, "tx" and "rx".



  - pinctrl-names	: Must contain a "default" entry.

- pinctrl-NNN: One property must exist for each entry in pinctrl-names.

  See ../pinctrl/pinctrl-bindings.txt for details of the property values.

- big-endian: Boolean property, required if all the FTM_PWM registers

  are big-endian rather than little-endian.

- 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.



  - pinctrl-NNN		: One property must exist for each entry in

			  pinctrl-names. See ../pinctrl/pinctrl-bindings.txt

			  for details of the property values.



  - big-endian		: Boolean property, required if all the FTM_PWM

			  registers are big-endian rather than little-endian.



  - 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 receiver will send and receive data by following

			  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.



  - fsl,sai-asynchronous: This is a boolean property. If present, indicating

  that SAI will work in the asynchronous mode, which means both transimitter

  and receiver will send and receive data by following their own bit clocks

  and frame sync clocks separately.

			  that SAI will work in the asynchronous mode, which

			  means both transimitter and receiver will send and

			  receive data by following their own bit clocks and

			  frame sync clocks separately.



Note:

- If both fsl,sai-asynchronous and fsl,sai-synchronous-rx are absent, the