From 8b5ebc010bd9e3c76f397a424a565da2d14e2f93 Mon Sep 17 00:00:00 2001 From: Simon Guinot Date: Sun, 16 Jul 2023 17:28:22 +0200 Subject: [PATCH] dts: bindings: pwm-leds: add description for pwms property This patch adds a description section for the pwms property of the PWM LED child node. This intends to explain how the period field is used by the led_pwm driver and to help with its configuration. Reported-by: Scott Worley Signed-off-by: Simon Guinot --- dts/bindings/led/pwm-leds.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/dts/bindings/led/pwm-leds.yaml b/dts/bindings/led/pwm-leds.yaml index f8942d20457..e9e9d131ee6 100644 --- a/dts/bindings/led/pwm-leds.yaml +++ b/dts/bindings/led/pwm-leds.yaml @@ -11,6 +11,14 @@ child-binding: pwms: required: true type: phandle-array + description: | + Reference to a PWM instance. + + The period field is used by the set_brightness function of the LED API. + Its value should at least be greater that 100 nanoseconds (for a full + brigtness granularity) and lesser than 50 milliseconds (average visual + persistence time of the human eye). Typical values for the PWM period + are 10 or 20 milliseconds. label: type: string