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 <scott.worley@microchip.com>
Signed-off-by: Simon Guinot <simon.guinot@seagate.com>
This commit is contained in:
Simon Guinot 2023-07-16 17:28:22 +02:00 committed by Fabio Baltieri
parent a4645908ee
commit 8b5ebc010b

View file

@ -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