summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt
diff options
context:
space:
mode:
authorScott Branden <sbranden@broadcom.com>2015-03-21 04:06:22 +0300
committerRob Herring <robh@kernel.org>2015-03-26 20:14:11 +0300
commit23a71fd616bf77fcc630ea514c469b0dd09cb99c (patch)
tree9172aa58dea51022af10f8f910dbdf00c120511c /Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt
parent9697a5595ece52a722d88f25a90ded0028e5e6b4 (diff)
downloadlinux-23a71fd616bf77fcc630ea514c469b0dd09cb99c.tar.xz
dt-bindings: brcm: rationalize Broadcom documentation naming
This patchset attempts to standardize the naming of dt-bindings documents based on the Broadcom vendor prefix of brcm. Although there are no guidelines currently present for how to name the dt-bindings document the "vendor,binding.txt" style is in use by some of the other vendors. Acked-by: Lee Jones <lee@kernel.org> Acked-by: Florian Fainelli <f.fainelli@gmail.com> Acked-by: Gregory Fong <gregory.0xf0@gmail.com> Acked-by: Stephen Warren <swarren@wwwdotorg.org> Signed-off-by: Scott Branden <sbranden@broadcom.com> Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt')
-rw-r--r--Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt b/Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt
new file mode 100644
index 000000000000..65783de0aedf
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/brcm,bcm2835-i2s.txt
@@ -0,0 +1,25 @@
+* Broadcom BCM2835 SoC I2S/PCM module
+
+Required properties:
+- compatible: "brcm,bcm2835-i2s"
+- reg: A list of base address and size entries:
+ * The first entry should cover the PCM registers
+ * The second entry should cover the PCM clock registers
+- dmas: List of DMA controller phandle and DMA request line ordered pairs.
+- dma-names: Identifier string for each DMA request line in the dmas property.
+ These strings correspond 1:1 with the ordered pairs in dmas.
+
+ One of the DMA channels will be responsible for transmission (should be
+ named "tx") and one for reception (should be named "rx").
+
+Example:
+
+bcm2835_i2s: i2s@7e203000 {
+ compatible = "brcm,bcm2835-i2s";
+ reg = <0x7e203000 0x20>,
+ <0x7e101098 0x02>;
+
+ dmas = <&dma 2>,
+ <&dma 3>;
+ dma-names = "tx", "rx";
+};