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

Commit 00e6cb2a authored by Lars-Peter Clausen's avatar Lars-Peter Clausen Committed by Mark Brown
Browse files

dt: Add bindings documentation for the ADI AXI-I2S controller 



This patch adds the devicetree documentation for the ADI AXI-SPDIF audio
controller. The controller has:
 * One set of memory mapped register
 * Two clocks, one for the memory mapped register interface, one used as the
   audio reference clock
 * One DMA interface each for the transmit and receive data

Signed-off-by: default avatarLars-Peter Clausen <lars@metafoo.de>
Cc: Rob Herring <rob.herring@calxeda.com>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Stephen Warren <swarren@wwwdotorg.org>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: devicetree@vger.kernel.org
Signed-off-by: default avatarMark Brown <broonie@linaro.org>
parent a22f33b0

Documentation/devicetree/bindings/sound/adi,axi-i2s.txt

0 → 100644
+31 −0
Original line number Diff line number Diff line 
ADI AXI-I2S controller



Required properties:

 - compatible : Must be "adi,axi-i2s-1.00.a"

 - reg : Must contain I2S core's registers location and length

 - clocks : Pairs of phandle and specifier referencing the controller's clocks.

   The controller expects two clocks, the clock used for the AXI interface and

   the clock used as the sampling rate reference clock sample.

 - clock-names : "axi" for the clock to the AXI interface, "ref" for the sample

   rate reference clock.

 - dmas: Pairs of phandle and specifier for the DMA channels that are used by

   the core. The core expects two dma channels, one for transmit and one for

   receive.

 - dma-names : "tx" for the transmit channel, "rx" for the receive channel.



For more details on the 'dma', 'dma-names', 'clock' and 'clock-names' properties

please check:

	* resource-names.txt

	* clock/clock-bindings.txt

	* dma/dma.txt



Example:



	i2s: i2s@0x77600000 {

		compatible = "adi,axi-i2s-1.00.a";

		reg = <0x77600000 0x1000>;

		clocks = <&clk 15>, <&audio_clock>;

		clock-names = "axi", "ref";

		dmas = <&ps7_dma 0>, <&ps7_dma 1>;

		dma-names = "tx", "rx";

	};