[PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[Kuninori Morimoto]

From: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>

This patch switches from .txt base to .yaml base Document.

Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/87mu4cxlo2.wl-kuninori.morimoto.gx@renesas.com
Link: https://lore.kernel.org/r/87o8pf3923.wl-kuninori.morimoto.gx@renesas.com
---
v2 -> v3
	- add Reviewd-by
	- add Link
	- use generic node name on examples
	
 .../devicetree/bindings/sound/ak4613.txt      | 27 --------
 .../devicetree/bindings/sound/ak4613.yaml     | 65 +++++++++++++++++++
 2 files changed, 65 insertions(+), 27 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/ak4613.txt
 create mode 100644 Documentation/devicetree/bindings/sound/ak4613.yaml

diff --git a/Documentation/devicetree/bindings/sound/ak4613.txt b/Documentation/devicetree/bindings/sound/ak4613.txt
deleted file mode 100644
index 49a2e74fd9cb..000000000000
--- a/Documentation/devicetree/bindings/sound/ak4613.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-AK4613 I2C transmitter
-
-This device supports I2C mode only.
-
-Required properties:
-
-- compatible : "asahi-kasei,ak4613"
-- reg : The chip select number on the I2C bus
-
-Optional properties:
-- asahi-kasei,in1-single-end	: Boolean. Indicate input / output pins are single-ended.
-- asahi-kasei,in2-single-end	  rather than differential.
-- asahi-kasei,out1-single-end
-- asahi-kasei,out2-single-end
-- asahi-kasei,out3-single-end
-- asahi-kasei,out4-single-end
-- asahi-kasei,out5-single-end
-- asahi-kasei,out6-single-end
-
-Example:
-
-&i2c {
-	ak4613: ak4613@10 {
-		compatible = "asahi-kasei,ak4613";
-		reg = <0x10>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/sound/ak4613.yaml b/Documentation/devicetree/bindings/sound/ak4613.yaml
new file mode 100644
index 000000000000..5aae6126c540
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/ak4613.yaml
@@ -0,0 +1,65 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/ak4613.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AK4613 I2C transmitter Device Tree Bindings
+
+maintainers:
+  - Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
+
+properties:
+  compatible:
+    const: asahi-kasei,ak4613
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  "#sound-dai-cells":
+    const: 0
+
+  # for OF-graph
+  port:
+    $ref: "audio-graph-card.yaml#definitions/port"
+  ports:
+    $ref: "audio-graph-card.yaml#definitions/ports"
+
+# use patternProperties to avoid naming "xxx,yyy" issue
+patternProperties:
+  "^asahi-kasei,in1-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,in2-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out1-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out2-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out3-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out4-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out5-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+  "^asahi-kasei,out6-single-end$":
+    $ref: /schemas/types.yaml#/definitions/flag
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        ak4613: codec@10 {
+            compatible = "asahi-kasei,ak4613";
+            reg = <0x10>;
+        };
+    };
-- 
2.25.1

Re: [PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[Mark Brown]

On 16 Jul 2020 09:31:01 +0900, Kuninori Morimoto wrote:
> This patch switches from .txt base to .yaml base Document.

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoC: dt-bindings: ak4613: switch to yaml base Documentation
      commit: 5b235b5522bf38f65cc76a9a008f179c37e0eb81

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark

Re: [PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[Rob Herring]

On Wed, Jul 15, 2020 at 6:31 PM Kuninori Morimoto
<kuninori.morimoto.gx@renesas.com> wrote:
>
> From: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
>
> This patch switches from .txt base to .yaml base Document.
>
> Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
> Reviewed-by: Rob Herring <robh@kernel.org>
> Link: https://lore.kernel.org/r/87mu4cxlo2.wl-kuninori.morimoto.gx@renesas.com
> Link: https://lore.kernel.org/r/87o8pf3923.wl-kuninori.morimoto.gx@renesas.com
> ---
> v2 -> v3
>         - add Reviewd-by
>         - add Link
>         - use generic node name on examples
>
>  .../devicetree/bindings/sound/ak4613.txt      | 27 --------
>  .../devicetree/bindings/sound/ak4613.yaml     | 65 +++++++++++++++++++
>  2 files changed, 65 insertions(+), 27 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/ak4613.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/ak4613.yaml
>
> diff --git a/Documentation/devicetree/bindings/sound/ak4613.txt b/Documentation/devicetree/bindings/sound/ak4613.txt
> deleted file mode 100644
> index 49a2e74fd9cb..000000000000
> --- a/Documentation/devicetree/bindings/sound/ak4613.txt
> +++ /dev/null
> @@ -1,27 +0,0 @@
> -AK4613 I2C transmitter
> -
> -This device supports I2C mode only.
> -
> -Required properties:
> -
> -- compatible : "asahi-kasei,ak4613"
> -- reg : The chip select number on the I2C bus
> -
> -Optional properties:
> -- asahi-kasei,in1-single-end   : Boolean. Indicate input / output pins are single-ended.
> -- asahi-kasei,in2-single-end     rather than differential.
> -- asahi-kasei,out1-single-end
> -- asahi-kasei,out2-single-end
> -- asahi-kasei,out3-single-end
> -- asahi-kasei,out4-single-end
> -- asahi-kasei,out5-single-end
> -- asahi-kasei,out6-single-end
> -
> -Example:
> -
> -&i2c {
> -       ak4613: ak4613@10 {
> -               compatible = "asahi-kasei,ak4613";
> -               reg = <0x10>;
> -       };
> -};
> diff --git a/Documentation/devicetree/bindings/sound/ak4613.yaml b/Documentation/devicetree/bindings/sound/ak4613.yaml
> new file mode 100644
> index 000000000000..5aae6126c540
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/ak4613.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/ak4613.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AK4613 I2C transmitter Device Tree Bindings
> +
> +maintainers:
> +  - Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
> +
> +properties:
> +  compatible:
> +    const: asahi-kasei,ak4613
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  "#sound-dai-cells":
> +    const: 0
> +
> +  # for OF-graph
> +  port:
> +    $ref: "audio-graph-card.yaml#definitions/port"

This patch is dependent on audio-graph-card.yaml which doesn't exist
and breaks linux-next now.

I haven't seen any follow-up to my audio-graph-card.yaml comments, so
please revert this.

Rob

Re: [PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 255 bytes --]

On Mon, Jul 27, 2020 at 08:39:23AM -0600, Rob Herring wrote:

> I haven't seen any follow-up to my audio-graph-card.yaml comments, so
> please revert this.

OK, Morimoto-san please resubmit as a series with the audio-graph-card
when you get back to that.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v3] ASoC: dt-bindings: ak4613: switch to yaml base Documentation

[Kuninori Morimoto]

Hi Mark

> > I haven't seen any follow-up to my audio-graph-card.yaml comments, so
> > please revert this.
> 
> OK, Morimoto-san please resubmit as a series with the audio-graph-card
> when you get back to that.

Oops, it was my fault.
My current plan is that 1st ak4613 YAML Doc doesn't support audio-graph-card.
It will be added later.
Just removing audio-graph-card part only is enough for ak4613, I think.
I will fixup and repost today.

Thank you for your help !!

Best regards
---
Kuninori Morimoto