ASoC: dt-bindings: Convert dmic-codec to DT schema

Convert the dmic-codec binding to DT schema format.

The '#sound-dai-cells' and 'sound-name-prefix' properties were not
documented, but are in use, so add them.

Signed-off-by: Rob Herring <robh@kernel.org>
---
 .../devicetree/bindings/sound/dmic-codec.yaml | 55 +++++++++++++++++++
 .../devicetree/bindings/sound/dmic.txt        | 22 --------
 2 files changed, 55 insertions(+), 22 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/dmic-codec.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/dmic.txt

On Tue, 11 Oct 2022 13:41:19 -0500, Rob Herring wrote:
> Convert the dmic-codec binding to DT schema format.
> 
> The '#sound-dai-cells' and 'sound-name-prefix' properties were not
> documented, but are in use, so add them.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/sound/dmic-codec.yaml | 55 +++++++++++++++++++
>  .../devicetree/bindings/sound/dmic.txt        | 22 --------
>  2 files changed, 55 insertions(+), 22 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/dmic-codec.yaml
>  delete mode 100644 Documentation/devicetree/bindings/sound/dmic.txt
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/sound/dmic-codec.example.dts:18:18: fatal error: dt-bindings/gpio.h: No such file or directory
   18 |         #include <dt-bindings/gpio.h>
      |                  ^~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[1]: *** [scripts/Makefile.lib:384: Documentation/devicetree/bindings/sound/dmic-codec.example.dtb] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1420: dt_binding_check] Error 2

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.

Hi Rob,

On 10/11/22 20:41, Rob Herring wrote:
> Convert the dmic-codec binding to DT schema format.
> 
> The '#sound-dai-cells' and 'sound-name-prefix' properties were not
> documented, but are in use, so add them.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/sound/dmic-codec.yaml | 55 +++++++++++++++++++
>  .../devicetree/bindings/sound/dmic.txt        | 22 --------
>  2 files changed, 55 insertions(+), 22 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/dmic-codec.yaml
>  delete mode 100644 Documentation/devicetree/bindings/sound/dmic.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/dmic-codec.yaml b/Documentation/devicetree/bindings/sound/dmic-codec.yaml
> new file mode 100644
> index 000000000000..767152fa99cc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/dmic-codec.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/dmic-codec.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Generic PDM Digital microphone (DMIC) codec
> +
> +maintainers:
> +  - Arnaud Pouliquen <arnaud.pouliquen@st.com>

I don't have much activity on the audio topic anymore, so I don't know if I'm
the best person.
But if one maintainer is needed, that's fine.
Please just change my email address to arnaud.pouliquen@foss.st.com
With that and the fix reported by the bot
Reviewed-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>

Thanks,
Arnaud

> +
> +allOf:
> +  - $ref: name-prefix.yaml#
> +
> +properties:
> +  compatible:
> +    const: dmic-codec
> +
> +  '#sound-dai-cells':
> +    const: 0
> +
> +  dmicen-gpios:
> +    description: GPIO specifier for DMIC to control start and stop
> +    maxItems: 1
> +
> +  num-channels:
> +    description: Number of microphones on this DAI
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 1
> +    maximum: 8
> +    default: 8
> +
> +  modeswitch-delay-ms:
> +    description: Delay (in ms) to complete DMIC mode switch
> +
> +  wakeup-delay-ms:
> +    description: Delay (in ms) after enabling the DMIC
> +
> +required:
> +  - compatible
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio.h>
> +
> +    dmic {
> +        compatible = "dmic-codec";
> +        dmicen-gpios = <&gpio4 3 GPIO_ACTIVE_HIGH>;
> +        num-channels = <1>;
> +        wakeup-delay-ms <50>;
> +        modeswitch-delay-ms <35>;
> +    };
> +...
> diff --git a/Documentation/devicetree/bindings/sound/dmic.txt b/Documentation/devicetree/bindings/sound/dmic.txt
> deleted file mode 100644
> index 32e871037269..000000000000
> --- a/Documentation/devicetree/bindings/sound/dmic.txt
> +++ /dev/null
> @@ -1,22 +0,0 @@
> -Device-Tree bindings for Digital microphone (DMIC) codec
> -
> -This device support generic PDM digital microphone.
> -
> -Required properties:
> -	- compatible: should be "dmic-codec".
> -
> -Optional properties:
> -	- dmicen-gpios: GPIO specifier for dmic to control start and stop
> -	- num-channels: Number of microphones on this DAI
> -	- wakeup-delay-ms: Delay (in ms) after enabling the DMIC
> -	- modeswitch-delay-ms: Delay (in ms) to complete DMIC mode switch
> -
> -Example node:
> -
> -	dmic_codec: dmic@0 {
> -		compatible = "dmic-codec";
> -		dmicen-gpios = <&gpio4 3 GPIO_ACTIVE_HIGH>;
> -		num-channels = <1>;
> -		wakeup-delay-ms <50>;
> -		modeswitch-delay-ms <35>;
> -	};

On Tue, 11 Oct 2022 13:41:19 -0500, Rob Herring wrote:
> Convert the dmic-codec binding to DT schema format.
> 
> The '#sound-dai-cells' and 'sound-name-prefix' properties were not
> documented, but are in use, so add them.
> 
> 

Applied to

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

Thanks!

[1/1] ASoC: dt-bindings: Convert dmic-codec to DT schema
      commit: 8da313ad1bd020859e2ee8a3e8e97e52425e539c

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