| Message ID | 20241121165829.8210-2-vicentiu.galanopulo@remote-tech.co.uk |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v9,1/3] Documentation:leds: Add leds-st1202.rst | expand |
On Thu, 21 Nov 2024, Vicentiu Galanopulo wrote: > Add usage for sysfs hw_pattern entry for leds-st1202 > > Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk> > --- > - Changes in v3: Add leds-st1202 to index.rst > - Changes in v2: Implement review comments > > Documentation/leds/index.rst | 1 + > Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++ > 2 files changed, 37 insertions(+) > create mode 100644 Documentation/leds/leds-st1202.rst > > diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst > index 3ade16c18328..0ab0a2128a11 100644 > --- a/Documentation/leds/index.rst > +++ b/Documentation/leds/index.rst > @@ -28,4 +28,5 @@ LEDs > leds-mlxcpld > leds-mt6370-rgb > leds-sc27xx > + leds-st1202.rst > leds-qcom-lpg > diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst > new file mode 100644 > index 000000000000..e647966e496c > --- /dev/null > +++ b/Documentation/leds/leds-st1202.rst > @@ -0,0 +1,36 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +============================================ > +Kernel driver for STMicroelectronics LED1202 > +============================================ > + > +/sys/class/leds/<led>/hw_pattern > +-------------------------------- > + > +Specify a hardware pattern for the ST1202 LED. The LED > +controller implements 12 low-side current generators > +with independent dimming control. Internal volatile memory > +allows the user to store up to 8 different patterns. > +Each pattern is a particular output configuration in terms > +of PWM duty-cycle and duration (ms). > + > +To be compatible with the hardware pattern > +format, maximum 8 tuples of brightness (PWM) and duration must > +be written to hw_pattern. Some very odd formatting here. Doesn't your editor do line-wrapping for you? > + > +- Min pattern duration: 22 ms > +- Max pattern duration: 5660 ms > + > +The format of the hardware pattern values should be: > +"brightness duration brightness duration ..." > + > +/sys/class/leds/<led>/repeat > +---------------------------- > + > +Specify a pattern repeat number, which is common for all channels. > +Default is 1; negative numbers and 0 are invalid. > + > +This file will always return the originally written repeat number. > + > +When the 255 value is written to it, all patterns will repeat > +indefinitely. > -- > 2.39.3 (Apple Git-145) >
diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst index 3ade16c18328..0ab0a2128a11 100644 --- a/Documentation/leds/index.rst +++ b/Documentation/leds/index.rst @@ -28,4 +28,5 @@ LEDs leds-mlxcpld leds-mt6370-rgb leds-sc27xx + leds-st1202.rst leds-qcom-lpg diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst new file mode 100644 index 000000000000..e647966e496c --- /dev/null +++ b/Documentation/leds/leds-st1202.rst @@ -0,0 +1,36 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================================ +Kernel driver for STMicroelectronics LED1202 +============================================ + +/sys/class/leds/<led>/hw_pattern +-------------------------------- + +Specify a hardware pattern for the ST1202 LED. The LED +controller implements 12 low-side current generators +with independent dimming control. Internal volatile memory +allows the user to store up to 8 different patterns. +Each pattern is a particular output configuration in terms +of PWM duty-cycle and duration (ms). + +To be compatible with the hardware pattern +format, maximum 8 tuples of brightness (PWM) and duration must +be written to hw_pattern. + +- Min pattern duration: 22 ms +- Max pattern duration: 5660 ms + +The format of the hardware pattern values should be: +"brightness duration brightness duration ..." + +/sys/class/leds/<led>/repeat +---------------------------- + +Specify a pattern repeat number, which is common for all channels. +Default is 1; negative numbers and 0 are invalid. + +This file will always return the originally written repeat number. + +When the 255 value is written to it, all patterns will repeat +indefinitely.
Add usage for sysfs hw_pattern entry for leds-st1202 Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk> --- - Changes in v3: Add leds-st1202 to index.rst - Changes in v2: Implement review comments Documentation/leds/index.rst | 1 + Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 Documentation/leds/leds-st1202.rst