dt-bindings: input: pwm-beeper: add volume

Message ID 20230201171025.965276-1-manuel.traut@mt.com
State New
Headers
Series dt-bindings: input: pwm-beeper: add volume |

Commit Message

Manuel Traut Feb. 1, 2023, 5:10 p.m. UTC
  Add an array of supported volume levels and a default volume level.

Signed-off-by: Manuel Traut <manuel.traut@mt.com>
---
 .../devicetree/bindings/input/pwm-beeper.yaml      | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
  

Comments

Rob Herring Feb. 3, 2023, 9:21 p.m. UTC | #1
On Wed, Feb 01, 2023 at 06:10:25PM +0100, Manuel Traut wrote:
> Add an array of supported volume levels and a default volume level.

Don't send a single updated patch in a series. It breaks tools and 
workflows.

> 
> Signed-off-by: Manuel Traut <manuel.traut@mt.com>
> ---
>  .../devicetree/bindings/input/pwm-beeper.yaml      | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.yaml b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
> index 1ebc3a46d934..7ea2954cdd6a 100644
> --- a/Documentation/devicetree/bindings/input/pwm-beeper.yaml
> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
> @@ -25,6 +25,18 @@ properties:
>    beeper-hz:
>      description: bell frequency in Hz
>  
> +  volume-levels-bp: 
> +    description: >
> +      Please note that the actual volume of most beepers is
> +      highly non-linear, which means that low volume levels
> +      are probably somewhere in the range of 10 to 300 (0.1-3%
> +      duty cycle).

This tells me nothing in terms of how to use this property. The index of 
the array is the volume level and the value is the PWM duty cycle?

> +    maximum: 5000

As this is an array, 'maximum' for the array doesn't make sense. It's a 
max for each entry:

items:
  maximum: 5000


> +
> +  default-volume-level-bp:
> +    description: >
> +      The default volume level.
> +
>  required:
>    - compatible
>    - pwms
> @@ -36,4 +48,6 @@ examples:
>      beeper {
>        compatible = "pwm-beeper";
>        pwms = <&pwm0>;
> +      volume-levels-bp = <0 80 200 400 5000>;
> +      default-volume-level-bp = <80>;
>      };
> -- 
> 2.39.1
>
  

Patch

diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.yaml b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
index 1ebc3a46d934..7ea2954cdd6a 100644
--- a/Documentation/devicetree/bindings/input/pwm-beeper.yaml
+++ b/Documentation/devicetree/bindings/input/pwm-beeper.yaml
@@ -25,6 +25,18 @@  properties:
   beeper-hz:
     description: bell frequency in Hz
 
+  volume-levels-bp:
+    description: >
+      Please note that the actual volume of most beepers is
+      highly non-linear, which means that low volume levels
+      are probably somewhere in the range of 10 to 300 (0.1-3%
+      duty cycle).
+    maximum: 5000
+
+  default-volume-level-bp:
+    description: >
+      The default volume level.
+
 required:
   - compatible
   - pwms
@@ -36,4 +48,6 @@  examples:
     beeper {
       compatible = "pwm-beeper";
       pwms = <&pwm0>;
+      volume-levels-bp = <0 80 200 400 5000>;
+      default-volume-level-bp = <80>;
     };