1*5b916aa7SHans de Goede.. SPDX-License-Identifier: GPL-2.0
2*5b916aa7SHans de Goede
3*5b916aa7SHans de Goede===========================================================
4*5b916aa7SHans de GoedeKernel driver for Intel Cherry Trail Whiskey Cove PMIC LEDs
5*5b916aa7SHans de Goede===========================================================
6*5b916aa7SHans de Goede
7*5b916aa7SHans de Goede/sys/class/leds/<led>/hw_pattern
8*5b916aa7SHans de Goede--------------------------------
9*5b916aa7SHans de Goede
10*5b916aa7SHans de GoedeSpecify a hardware pattern for the Whiskey Cove PMIC LEDs.
11*5b916aa7SHans de Goede
12*5b916aa7SHans de GoedeThe only supported pattern is hardware breathing mode::
13*5b916aa7SHans de Goede
14*5b916aa7SHans de Goede    "0 2000 1 2000"
15*5b916aa7SHans de Goede
16*5b916aa7SHans de Goede	^
17*5b916aa7SHans de Goede	|
18*5b916aa7SHans de Goede    Max-|     ---
19*5b916aa7SHans de Goede	|    /   \
20*5b916aa7SHans de Goede	|   /     \
21*5b916aa7SHans de Goede	|  /       \     /
22*5b916aa7SHans de Goede	| /         \   /
23*5b916aa7SHans de Goede    Min-|-           ---
24*5b916aa7SHans de Goede	|
25*5b916aa7SHans de Goede	0------2------4--> time (sec)
26*5b916aa7SHans de Goede
27*5b916aa7SHans de GoedeThe rise and fall times must be the same value.
28*5b916aa7SHans de GoedeSupported values are 2000, 1000, 500 and 250 for
29*5b916aa7SHans de Goedebreathing frequencies of 1/4, 1/2, 1 and 2 Hz.
30*5b916aa7SHans de Goede
31*5b916aa7SHans de GoedeThe set pattern only controls the timing. For max brightness the last
32*5b916aa7SHans de Goedeset brightness is used and the max brightness can be changed
33*5b916aa7SHans de Goedewhile breathing by writing the brightness attribute.
34*5b916aa7SHans de Goede
35*5b916aa7SHans de GoedeThis is just like how blinking works in the LED subsystem,
36*5b916aa7SHans de Goedefor both sw and hw blinking the brightness can also be changed
37*5b916aa7SHans de Goedewhile blinking. Breathing on this hw really is just a variant
38*5b916aa7SHans de Goedemode of blinking.
39