[PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[Vicentiu Galanopulo]

Add usage for sysfs hw_pattern entry for leds-st1202 

Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>
---
 Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/leds/leds-st1202.rst

diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst
new file mode 100644
index 000000000000..72286a512c69
--- /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, other negative numbers and number 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)

Re: [PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[Randy Dunlap]

Hi,

On 10/26/24 7:48 AM, Vicentiu Galanopulo wrote:
> Add usage for sysfs hw_pattern entry for leds-st1202 
> 
> Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>
> ---
>  Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
>  create mode 100644 Documentation/leds/leds-st1202.rst
> 
> diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst
> new file mode 100644
> index 000000000000..72286a512c69
> --- /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

no comma     ^

> +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, other negative numbers and number 0 are invalid.

   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.

-- 
~Randy

Re: [PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[Vicentiu Galanopulo]

Hi Randy,
Thanks for the review. Addressed all comments.

Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>
---

Changes in v2: Implement review comments

 Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/leds/leds-st1202.rst

diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst
new file mode 100644
index 000000000000..72286a512c69
--- /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.
-- 
2.39.3 (Apple Git-145)

Re: [PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[Randy Dunlap]

Hi,


On 10/30/24 3:09 PM, Vicentiu Galanopulo wrote:
> Hi Randy,
> Thanks for the review. Addressed all comments.
> 
> Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
> Changes in v2: Implement review comments
> 
>  Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
>  create mode 100644 Documentation/leds/leds-st1202.rst
> 
> diff --git a/Documentation/leds/leds-st1202.rst b/Documentation/leds/leds-st1202.rst
> new file mode 100644
> index 000000000000..72286a512c69
> --- /dev/null
> +++ b/Documentation/leds/leds-st1202.rst

-- 
~Randy

Re: [PATCH v1 3/3] Documentation:leds: Add leds-st1202.rst

[Jonathan Corbet]

Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk> writes:

> Hi Randy,
> Thanks for the review. Addressed all comments.
>
> Signed-off-by: Vicentiu Galanopulo <vicentiu.galanopulo@remote-tech.co.uk>
> ---
>
> Changes in v2: Implement review comments
>
>  Documentation/leds/leds-st1202.rst | 36 ++++++++++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
>  create mode 100644 Documentation/leds/leds-st1202.rst

This is a new file, so you need to add it to index.rst in that
directory.

Also, please post followup patches in their own thread (not as a reply)
and include the full changelog text.

Thanks,

jon