Convert the STM32 I2S bindings to DT schema format using json-schema.
Signed-off-by: Olivier Moysan <[email protected]>
---
The items for dma-names and clock-names properties are all
mandatory, but may be provided in any order.
The syntax used for these properties allows to avoid order constraint.
---
.../bindings/sound/st,stm32-i2s.txt | 62 -------------
.../bindings/sound/st,stm32-i2s.yaml | 91 +++++++++++++++++++
2 files changed, 91 insertions(+), 62 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
create mode 100644 Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
diff --git a/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt b/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
deleted file mode 100644
index cbf24bcd1b8d..000000000000
--- a/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-STMicroelectronics STM32 SPI/I2S Controller
-
-The SPI/I2S block supports I2S/PCM protocols when configured on I2S mode.
-Only some SPI instances support I2S.
-
-Required properties:
- - compatible: Must be "st,stm32h7-i2s"
- - reg: Offset and length of the device's register set.
- - interrupts: Must contain the interrupt line id.
- - clocks: Must contain phandle and clock specifier pairs for each entry
- in clock-names.
- - clock-names: Must contain "i2sclk", "pclk", "x8k" and "x11k".
- "i2sclk": clock which feeds the internal clock generator
- "pclk": clock which feeds the peripheral bus interface
- "x8k": I2S parent clock for sampling rates multiple of 8kHz.
- "x11k": I2S parent clock for sampling rates multiple of 11.025kHz.
- - dmas: DMA specifiers for tx and rx dma.
- See Documentation/devicetree/bindings/dma/stm32-dma.txt.
- - dma-names: Identifier for each DMA request line. Must be "tx" and "rx".
- - pinctrl-names: should contain only value "default"
- - pinctrl-0: see Documentation/devicetree/bindings/pinctrl/st,stm32-pinctrl.yaml
-
-Optional properties:
- - resets: Reference to a reset controller asserting the reset controller
-
-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:
-sound_card {
- compatible = "audio-graph-card";
- dais = <&i2s2_port>;
-};
-
-i2s2: audio-controller@40003800 {
- compatible = "st,stm32h7-i2s";
- reg = <0x40003800 0x400>;
- interrupts = <36>;
- clocks = <&rcc PCLK1>, <&rcc SPI2_CK>, <&rcc PLL1_Q>, <&rcc PLL2_P>;
- clock-names = "pclk", "i2sclk", "x8k", "x11k";
- dmas = <&dmamux2 2 39 0x400 0x1>,
- <&dmamux2 3 40 0x400 0x1>;
- dma-names = "rx", "tx";
- pinctrl-names = "default";
- pinctrl-0 = <&pinctrl_i2s2>;
-
- i2s2_port: port@0 {
- cpu_endpoint: endpoint {
- remote-endpoint = <&codec_endpoint>;
- format = "i2s";
- };
- };
-};
-
-audio-codec {
- codec_port: port@0 {
- codec_endpoint: endpoint {
- remote-endpoint = <&cpu_endpoint>;
- };
- };
-};
diff --git a/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
new file mode 100644
index 000000000000..cdfb375c7a14
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
@@ -0,0 +1,91 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/st,stm32-i2s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: STMicroelectronics STM32 SPI/I2S Controller
+
+maintainers:
+ - Olivier Moysan <[email protected]>
+
+description:
+ The SPI/I2S block supports I2S/PCM protocols when configured on I2S mode.
+ Only some SPI instances support I2S.
+
+properties:
+ compatible:
+ enum:
+ - st,stm32h7-i2s
+
+ "#sound-dai-cells":
+ const: 0
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: clock feeding the peripheral bus interface.
+ - description: clock feeding the internal clock generator.
+ - description: I2S parent clock for sampling rates multiple of 8kHz.
+ - description: I2S parent clock for sampling rates multiple of 11.025kHz.
+
+ clock-names:
+ items:
+ - enum: [ pclk, i2sclk, x8k, x11k ]
+ - enum: [ pclk, i2sclk, x8k, x11k ]
+ - enum: [ pclk, i2sclk, x8k, x11k ]
+ - enum: [ pclk, i2sclk, x8k, x11k ]
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/string-array
+
+ interrupts:
+ maxItems: 1
+
+ dmas:
+ items:
+ - description: audio capture DMA.
+ - description: audio playback DMA.
+
+ dma-names:
+ items:
+ - enum: [ rx, tx ]
+ - enum: [ rx, tx ]
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/string-array
+
+ resets:
+ maxItems: 1
+
+required:
+ - compatible
+ - "#sound-dai-cells"
+ - reg
+ - clocks
+ - clock-names
+ - interrupts
+ - dmas
+ - dma-names
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/arm-gic.h>
+ #include <dt-bindings/clock/stm32mp1-clks.h>
+ i2s2: audio-controller@4000b000 {
+ compatible = "st,stm32h7-i2s";
+ #sound-dai-cells = <0>;
+ reg = <0x4000b000 0x400>;
+ clocks = <&rcc SPI2>, <&rcc SPI2_K>, <&rcc PLL3_Q>, <&rcc PLL3_R>;
+ clock-names = "pclk", "i2sclk", "x8k", "x11k";
+ interrupts = <GIC_SPI 35 IRQ_TYPE_LEVEL_HIGH>;
+ dmas = <&dmamux1 39 0x400 0x01>,
+ <&dmamux1 40 0x400 0x01>;
+ dma-names = "rx", "tx";
+ pinctrl-names = "default";
+ pinctrl-0 = <&i2s2_pins_a>;
+ };
+
+...
--
2.17.1
On Mon, Jan 27, 2020 at 01:54:20PM +0100, Olivier Moysan wrote:
> Convert the STM32 I2S bindings to DT schema format using json-schema.
>
> Signed-off-by: Olivier Moysan <[email protected]>
> ---
> The items for dma-names and clock-names properties are all
> mandatory, but may be provided in any order.
> The syntax used for these properties allows to avoid order constraint.
Other than having .dts files with differing order, I don't see any
reason we need to allow any order here. So decide which order is most
prevalent and use that, and then fix the other dts files.
> ---
> .../bindings/sound/st,stm32-i2s.txt | 62 -------------
> .../bindings/sound/st,stm32-i2s.yaml | 91 +++++++++++++++++++
> 2 files changed, 91 insertions(+), 62 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
> create mode 100644 Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
>
> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt b/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
> deleted file mode 100644
> index cbf24bcd1b8d..000000000000
> --- a/Documentation/devicetree/bindings/sound/st,stm32-i2s.txt
> +++ /dev/null
> @@ -1,62 +0,0 @@
> -STMicroelectronics STM32 SPI/I2S Controller
> -
> -The SPI/I2S block supports I2S/PCM protocols when configured on I2S mode.
> -Only some SPI instances support I2S.
> -
> -Required properties:
> - - compatible: Must be "st,stm32h7-i2s"
> - - reg: Offset and length of the device's register set.
> - - interrupts: Must contain the interrupt line id.
> - - clocks: Must contain phandle and clock specifier pairs for each entry
> - in clock-names.
> - - clock-names: Must contain "i2sclk", "pclk", "x8k" and "x11k".
> - "i2sclk": clock which feeds the internal clock generator
> - "pclk": clock which feeds the peripheral bus interface
> - "x8k": I2S parent clock for sampling rates multiple of 8kHz.
> - "x11k": I2S parent clock for sampling rates multiple of 11.025kHz.
> - - dmas: DMA specifiers for tx and rx dma.
> - See Documentation/devicetree/bindings/dma/stm32-dma.txt.
> - - dma-names: Identifier for each DMA request line. Must be "tx" and "rx".
> - - pinctrl-names: should contain only value "default"
> - - pinctrl-0: see Documentation/devicetree/bindings/pinctrl/st,stm32-pinctrl.yaml
> -
> -Optional properties:
> - - resets: Reference to a reset controller asserting the reset controller
> -
> -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:
> -sound_card {
> - compatible = "audio-graph-card";
> - dais = <&i2s2_port>;
> -};
> -
> -i2s2: audio-controller@40003800 {
> - compatible = "st,stm32h7-i2s";
> - reg = <0x40003800 0x400>;
> - interrupts = <36>;
> - clocks = <&rcc PCLK1>, <&rcc SPI2_CK>, <&rcc PLL1_Q>, <&rcc PLL2_P>;
> - clock-names = "pclk", "i2sclk", "x8k", "x11k";
> - dmas = <&dmamux2 2 39 0x400 0x1>,
> - <&dmamux2 3 40 0x400 0x1>;
> - dma-names = "rx", "tx";
> - pinctrl-names = "default";
> - pinctrl-0 = <&pinctrl_i2s2>;
> -
> - i2s2_port: port@0 {
> - cpu_endpoint: endpoint {
> - remote-endpoint = <&codec_endpoint>;
> - format = "i2s";
> - };
> - };
> -};
> -
> -audio-codec {
> - codec_port: port@0 {
> - codec_endpoint: endpoint {
> - remote-endpoint = <&cpu_endpoint>;
> - };
> - };
> -};
> diff --git a/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
> new file mode 100644
> index 000000000000..cdfb375c7a14
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml
> @@ -0,0 +1,91 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/st,stm32-i2s.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: STMicroelectronics STM32 SPI/I2S Controller
> +
> +maintainers:
> + - Olivier Moysan <[email protected]>
> +
> +description:
> + The SPI/I2S block supports I2S/PCM protocols when configured on I2S mode.
> + Only some SPI instances support I2S.
> +
> +properties:
> + compatible:
> + enum:
> + - st,stm32h7-i2s
> +
> + "#sound-dai-cells":
> + const: 0
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + items:
> + - description: clock feeding the peripheral bus interface.
> + - description: clock feeding the internal clock generator.
> + - description: I2S parent clock for sampling rates multiple of 8kHz.
> + - description: I2S parent clock for sampling rates multiple of 11.025kHz.
> +
> + clock-names:
> + items:
> + - enum: [ pclk, i2sclk, x8k, x11k ]
> + - enum: [ pclk, i2sclk, x8k, x11k ]
> + - enum: [ pclk, i2sclk, x8k, x11k ]
> + - enum: [ pclk, i2sclk, x8k, x11k ]
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/string-array
*-names already has a type, so this is not needed.
> +
> + interrupts:
> + maxItems: 1
> +
> + dmas:
> + items:
> + - description: audio capture DMA.
> + - description: audio playback DMA.
> +
> + dma-names:
> + items:
> + - enum: [ rx, tx ]
> + - enum: [ rx, tx ]
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/string-array
> +
> + resets:
> + maxItems: 1
> +
> +required:
> + - compatible
> + - "#sound-dai-cells"
> + - reg
> + - clocks
> + - clock-names
> + - interrupts
> + - dmas
> + - dma-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/clock/stm32mp1-clks.h>
> + i2s2: audio-controller@4000b000 {
> + compatible = "st,stm32h7-i2s";
> + #sound-dai-cells = <0>;
> + reg = <0x4000b000 0x400>;
> + clocks = <&rcc SPI2>, <&rcc SPI2_K>, <&rcc PLL3_Q>, <&rcc PLL3_R>;
> + clock-names = "pclk", "i2sclk", "x8k", "x11k";
> + interrupts = <GIC_SPI 35 IRQ_TYPE_LEVEL_HIGH>;
> + dmas = <&dmamux1 39 0x400 0x01>,
> + <&dmamux1 40 0x400 0x01>;
> + dma-names = "rx", "tx";
> + pinctrl-names = "default";
> + pinctrl-0 = <&i2s2_pins_a>;
> + };
> +
> +...
> --
> 2.17.1
>