diff mbox

[1/2] dt-bindings: Document the STM32 SPDIFRX interface

Message ID 1497621452-615-2-git-send-email-olivier.moysan@st.com (mailing list archive)
State New, archived
Headers show

Commit Message

Olivier MOYSAN June 16, 2017, 1:57 p.m. UTC
This adds documentation of device tree bindings for the
STM32 SPDIFRX interface.

Signed-off-by: olivier moysan <olivier.moysan@st.com>
---
 .../devicetree/bindings/sound/st,stm32-spdifrx.txt | 56 ++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt

Comments

Rob Herring (Arm) June 23, 2017, 6:55 p.m. UTC | #1
On Fri, Jun 16, 2017 at 03:57:31PM +0200, olivier moysan wrote:
> This adds documentation of device tree bindings for the
> STM32 SPDIFRX interface.
> 
> Signed-off-by: olivier moysan <olivier.moysan@st.com>
> ---
>  .../devicetree/bindings/sound/st,stm32-spdifrx.txt | 56 ++++++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
> new file mode 100644
> index 0000000..33826f2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
> @@ -0,0 +1,56 @@
> +STMicroelectronics STM32 S/PDIF receiver (SPDIFRX).
> +
> +The SPDIFRX peripheral, is designed to receive an S/PDIF flow compliant with
> +IEC-60958 and IEC-61937.
> +
> +Required properties:
> +  - compatible: should be "st,stm32h7-spdifrx"
> +  - reg: cpu DAI IP base address and size
> +  - clocks: must contain an entry for kclk (used as S/PDIF signal reference)
> +  - clock-names: must contain "kclk"
> +  - interrupts: cpu DAI interrupt line
> +  - dmas: DMA specifiers for audio data DMA and iec control flow DMA
> +    See STM32 DMA bindings, Documentation/devicetree/bindings/dma/stm32-dma.txt
> +  - dma-names: two dmas have to be defined, "rx" and "rx-ctrl"
> +
> +Optional properties:
> +  - resets: Reference to a reset controller asserting the SPDIFRX
> +
> +The device node should contain one 'port' child node with one child 'endpoint'
> +node, according to the bindings defined in Documentation/devicetree/bindings/
> +graph.txt.
> +
> +Example:
> +spdifrx: spdifrx@40004000 {
> +	compatible = "st,stm32h7-spdifrx";
> +	reg = <0x40004000 0x400>;
> +	clocks = <&rcc SPDIFRX_CK>;
> +	clock-names = "kclk";
> +	interrupts = <97>;
> +	dmas = <&dmamux1 2 93 0x400 0x0>,
> +	       <&dmamux1 3 94 0x400 0x0>;
> +	dma-names = "rx", "rx-ctrl";
> +	pinctrl-0 = <&spdifrx_pins>;
> +	pinctrl-names = "default";
> +
> +	spdifrx_port: port {
> +		cpu_endpoint: endpoint {
> +			remote-endpoint = <&codec_endpoint>;
> +		};
> +	};
> +};
> +
> +spdif_in: spdif-in {
> +	compatible = "linux,spdif-dir";

What is this? It should go.

Rob
Olivier MOYSAN June 27, 2017, 3:23 p.m. UTC | #2
Hello Rob,

On 06/23/2017 08:55 PM, Rob Herring wrote:
> On Fri, Jun 16, 2017 at 03:57:31PM +0200, olivier moysan wrote:
>> This adds documentation of device tree bindings for the
>> STM32 SPDIFRX interface.
>>
>> Signed-off-by: olivier moysan <olivier.moysan@st.com>
>> ---
>>   .../devicetree/bindings/sound/st,stm32-spdifrx.txt | 56 ++++++++++++++++++++++
>>   1 file changed, 56 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
>>
>> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
>> new file mode 100644
>> index 0000000..33826f2
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
>> @@ -0,0 +1,56 @@
>> +STMicroelectronics STM32 S/PDIF receiver (SPDIFRX).
>> +
>> +The SPDIFRX peripheral, is designed to receive an S/PDIF flow compliant with
>> +IEC-60958 and IEC-61937.
>> +
>> +Required properties:
>> +  - compatible: should be "st,stm32h7-spdifrx"
>> +  - reg: cpu DAI IP base address and size
>> +  - clocks: must contain an entry for kclk (used as S/PDIF signal reference)
>> +  - clock-names: must contain "kclk"
>> +  - interrupts: cpu DAI interrupt line
>> +  - dmas: DMA specifiers for audio data DMA and iec control flow DMA
>> +    See STM32 DMA bindings, Documentation/devicetree/bindings/dma/stm32-dma.txt
>> +  - dma-names: two dmas have to be defined, "rx" and "rx-ctrl"
>> +
>> +Optional properties:
>> +  - resets: Reference to a reset controller asserting the SPDIFRX
>> +
>> +The device node should contain one 'port' child node with one child 'endpoint'
>> +node, according to the bindings defined in Documentation/devicetree/bindings/
>> +graph.txt.
>> +
>> +Example:
>> +spdifrx: spdifrx@40004000 {
>> +	compatible = "st,stm32h7-spdifrx";
>> +	reg = <0x40004000 0x400>;
>> +	clocks = <&rcc SPDIFRX_CK>;
>> +	clock-names = "kclk";
>> +	interrupts = <97>;
>> +	dmas = <&dmamux1 2 93 0x400 0x0>,
>> +	       <&dmamux1 3 94 0x400 0x0>;
>> +	dma-names = "rx", "rx-ctrl";
>> +	pinctrl-0 = <&spdifrx_pins>;
>> +	pinctrl-names = "default";
>> +
>> +	spdifrx_port: port {
>> +		cpu_endpoint: endpoint {
>> +			remote-endpoint = <&codec_endpoint>;
>> +		};
>> +	};
>> +};
>> +
>> +spdif_in: spdif-in {
>> +	compatible = "linux,spdif-dir";
> 
> What is this? It should go.
> 
> Rob
> 

This is the ASoC spdif stub codec. This is relevant in DT when
spdif interface is wired to a connector.
I will remove it from bindings.

BRs
olivier
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
new file mode 100644
index 0000000..33826f2
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/st,stm32-spdifrx.txt
@@ -0,0 +1,56 @@ 
+STMicroelectronics STM32 S/PDIF receiver (SPDIFRX).
+
+The SPDIFRX peripheral, is designed to receive an S/PDIF flow compliant with
+IEC-60958 and IEC-61937.
+
+Required properties:
+  - compatible: should be "st,stm32h7-spdifrx"
+  - reg: cpu DAI IP base address and size
+  - clocks: must contain an entry for kclk (used as S/PDIF signal reference)
+  - clock-names: must contain "kclk"
+  - interrupts: cpu DAI interrupt line
+  - dmas: DMA specifiers for audio data DMA and iec control flow DMA
+    See STM32 DMA bindings, Documentation/devicetree/bindings/dma/stm32-dma.txt
+  - dma-names: two dmas have to be defined, "rx" and "rx-ctrl"
+
+Optional properties:
+  - resets: Reference to a reset controller asserting the SPDIFRX
+
+The device node should contain one 'port' child node with one child 'endpoint'
+node, according to the bindings defined in Documentation/devicetree/bindings/
+graph.txt.
+
+Example:
+spdifrx: spdifrx@40004000 {
+	compatible = "st,stm32h7-spdifrx";
+	reg = <0x40004000 0x400>;
+	clocks = <&rcc SPDIFRX_CK>;
+	clock-names = "kclk";
+	interrupts = <97>;
+	dmas = <&dmamux1 2 93 0x400 0x0>,
+	       <&dmamux1 3 94 0x400 0x0>;
+	dma-names = "rx", "rx-ctrl";
+	pinctrl-0 = <&spdifrx_pins>;
+	pinctrl-names = "default";
+
+	spdifrx_port: port {
+		cpu_endpoint: endpoint {
+			remote-endpoint = <&codec_endpoint>;
+		};
+	};
+};
+
+spdif_in: spdif-in {
+	compatible = "linux,spdif-dir";
+
+	codec_port: port {
+		codec_endpoint: endpoint {
+			remote-endpoint = <&cpu_endpoint>;
+		};
+	};
+};
+
+soundcard {
+	compatible = "audio-graph-card";
+	dais = <&spdifrx_port>;
+};