Re: [PATCH v4] dt-bindings: sound: gtm601: convert to YAML

[Guido Günther]

Hi,

On Sun, Jul 30, 2023 at 10:17:42PM +0300, David Heidelberg wrote:
> Convert GTM601 binding to the YAML format.
> 
> Signed-off-by: David Heidelberg <david@xxxxxxx>
> ---
> v4:
>  - added missing required property
> v3:
>  - incorporated feedback from Krzysztof
> v2:
>  - add #sound-dai-cells
>  - put kernel@xxxxxxx into maintainers
> 
>  .../devicetree/bindings/sound/gtm601.txt      | 19 ---------
>  .../bindings/sound/option,gtm601.yaml         | 40 +++++++++++++++++++
>  2 files changed, 40 insertions(+), 19 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/gtm601.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/option,gtm601.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/gtm601.txt b/Documentation/devicetree/bindings/sound/gtm601.txt
> deleted file mode 100644
> index efa32a486c4a..000000000000
> --- a/Documentation/devicetree/bindings/sound/gtm601.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -GTM601 UMTS modem audio interface CODEC
> -
> -This device has no configuration interface. The sample rate and channels are
> -based on the compatible string
> -	"option,gtm601" = 8kHz mono
> -	"broadmobi,bm818" = 48KHz stereo
> -
> -Required properties:
> -
> -  - compatible : one of
> -	"option,gtm601"
> -	"broadmobi,bm818"
> -
> -
> -Example:
> -
> -codec: gtm601_codec {
> -	compatible = "option,gtm601";
> -};
> diff --git a/Documentation/devicetree/bindings/sound/option,gtm601.yaml b/Documentation/devicetree/bindings/sound/option,gtm601.yaml
> new file mode 100644
> index 000000000000..69c2ccc79dc5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/option,gtm601.yaml
> @@ -0,0 +1,40 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/option,gtm601.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: GTM601 UMTS modem audio interface CODEC
> +
> +maintainers:
> +  - kernel@xxxxxxx
> +
> +description: >
> +  This device has no configuration interface. The sample rate and channels are
> +  based on the compatible string
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:  # 48 kHz stereo
> +          - const: broadmobi,bm818
> +          - const: option,gtm601
> +      - const: option,gtm601  # 8 kHz mono

This looks good to me. I just wonder if it makes sense to use a description
instead of comments to make the sampling rate/channel requirements a bit
more obvious:

      - description: Broadmobi BM818 (48kHz stereo)
        items:
           - const: broadmobi,bm818
           - const: option,gtm601
      - description:  Option GTM601 audio code (8kHz mono) 
        const: option,gtm601

Cheers,
 -- Guido

> +
> +  '#sound-dai-cells':
> +    const: 0
> +
> +required:
> +  - compatible
> +
> +allOf:
> +  - $ref: dai-common.yaml#
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    codec {
> +        compatible = "option,gtm601";
> +        #sound-dai-cells = <0>;
> +    };
> -- 
> 2.40.1
>