Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20230328054833.1974942-1-peng.fan@oss.nxp.com>
In-Reply-To: <20230328054833.1974942-1-peng.fan@oss.nxp.com>
From:   Rob Herring <robh+dt@kernel.org>
Date:   Tue, 28 Mar 2023 08:54:56 -0500
Message-ID: <CAL_JsqKbOSQAZhA+Xapgwpqzuoo44ZF13+MziNHm5ye5Js8kfA@mail.gmail.com>
Subject: Re: [PATCH] dt-bindings: input: pwm-beeper: convert to dt schema
To:     "Peng Fan (OSS)" <peng.fan@oss.nxp.com>
Cc:     dmitry.torokhov@gmail.com, krzysztof.kozlowski+dt@linaro.org,
        s.hauer@pengutronix.de, linux-input@vger.kernel.org,
        devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        Peng Fan <peng.fan@nxp.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On Tue, Mar 28, 2023 at 12:43=E2=80=AFAM Peng Fan (OSS) <peng.fan@oss.nxp.c=
om> wrote:
>
> From: Peng Fan <peng.fan@nxp.com>
>
> Convert the binding doc to dt schema, and also fixed the
> example from fixed-regulator to regulator-fixed.
>
> Signed-off-by: Peng Fan <peng.fan@nxp.com>
> ---
>  .../devicetree/bindings/input/pwm-beeper.txt  | 24 ----------
>  .../devicetree/bindings/input/pwm-beeper.yaml | 48 +++++++++++++++++++
>  2 files changed, 48 insertions(+), 24 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/input/pwm-beeper.tx=
t
>  create mode 100644 Documentation/devicetree/bindings/input/pwm-beeper.ya=
ml
>
> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Doc=
umentation/devicetree/bindings/input/pwm-beeper.txt
> deleted file mode 100644
> index 8fc0e48c20db..000000000000
> --- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
> +++ /dev/null
> @@ -1,24 +0,0 @@
> -* PWM beeper device tree bindings
> -
> -Registers a PWM device as beeper.
> -
> -Required properties:
> -- compatible: should be "pwm-beeper"
> -- pwms: phandle to the physical PWM device
> -
> -Optional properties:
> -- amp-supply: phandle to a regulator that acts as an amplifier for the b=
eeper
> -- beeper-hz:  bell frequency in Hz
> -
> -Example:
> -
> -beeper_amp: amplifier {
> -       compatible =3D "fixed-regulator";
> -       gpios =3D <&gpio0 1 GPIO_ACTIVE_HIGH>;
> -};
> -
> -beeper {
> -       compatible =3D "pwm-beeper";
> -       pwms =3D <&pwm0>;
> -       amp-supply =3D <&beeper_amp>;
> -};
> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.yaml b/Do=
cumentation/devicetree/bindings/input/pwm-beeper.yaml
> new file mode 100644
> index 000000000000..1d7cd58d2a8f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
> @@ -0,0 +1,48 @@
> +# SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)

'or-later' is wrong.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/pwm-beeper.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: PWM beeper
> +
> +maintainers:
> +  - Sascha Hauer <s.hauer@pengutronix.de>
> +
> +properties:
> +  compatible:
> +    items:

Drop 'items' as there is only 1.

> +      - const: pwm-beeper
> +
> +  pwms:
> +    description: Phandle to the physical PWM device
> +    $ref: /schemas/types.yaml#/definitions/phandle

Standard property which already has a type.

> +
> +  amp-supply:
> +    description: Phandle to a regulator that acts as an amplifier for th=
e beeper
> +
> +  beeper-hz:
> +    description: bell frequency in Hz
> +    minimum: 1
> +    maximum: 255

doubtful a beeper can generate frequencies of 1-255Hz...

> +
> +required:
> +  - compatible
> +  - pwms
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    beeper_amp: amplifier {

Don't need to show providers in examples for the consumer.

> +       compatible =3D "regulator-fixed";
> +       gpios =3D <&gpio0 1 GPIO_ACTIVE_HIGH>;
> +       regulator-name =3D "beeper_amp";
> +    };
> +
> +    beeper {
> +        compatible =3D "pwm-beeper";
> +        pwms =3D <&pwm0>;
> +        amp-supply =3D <&beeper_amp>;

Make the example complete and add beeper-hz.

> +    };
> --
> 2.37.1
>