[linux-block.git] / Documentation / leds / leds-el15203000.rst

.. SPDX-License-Identifier: GPL-2.0

==================================
Kernel driver for Crane EL15203000
==================================

/sys/class/leds/<led>/hw_pattern
--------------------------------

Specify a hardware pattern for the EL15203000 LED.

The LEDs board supports only predefined patterns by firmware
for specific LEDs.

Breathing mode for Screen frame light tube::

    "0 4000 1 4000"

	^
	|
    Max-|     ---
	|    /   \
	|   /     \
	|  /       \     /
	| /         \   /
    Min-|-           ---
	|
	0------4------8--> time (sec)

Cascade mode for Pipe LED::

    "1 800 2 800 4 800 8 800 16 800"

	^
	|
  0 On -|----+                   +----+                   +---
	|    |                   |    |                   |
    Off-|    +-------------------+    +-------------------+
	|
  1 On -|    +----+                   +----+
	|    |    |                   |    |
    Off |----+    +-------------------+    +------------------
	|
  2 On -|         +----+                   +----+
	|         |    |                   |    |
    Off-|---------+    +-------------------+    +-------------
	|
  3 On -|              +----+                   +----+
	|              |    |                   |    |
    Off-|--------------+    +-------------------+    +--------
	|
  4 On -|                   +----+                   +----+
	|                   |    |                   |    |
    Off-|-------------------+    +-------------------+    +---
	|
	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)

Inverted cascade mode for Pipe LED::

    "30 800 29 800 27 800 23 800 15 800"

	^
	|
  0 On -|    +-------------------+    +-------------------+
	|    |                   |    |                   |
    Off-|----+                   +----+                   +---
	|
  1 On -|----+    +-------------------+    +------------------
	|    |    |                   |    |
    Off |    +----+                   +----+
	|
  2 On -|---------+    +-------------------+    +-------------
	|         |    |                   |    |
    Off-|         +----+                   +----+
	|
  3 On -|--------------+    +-------------------+    +--------
	|              |    |                   |    |
    Off-|              +----+                   +----+
	|
  4 On -|-------------------+    +-------------------+    +---
	|                   |    |                   |    |
    Off-|                   +----+                   +----+
	|
	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)

Bounce mode for Pipe LED::

    "1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"

	^
	|
  0 On -|----+                                       +--------
	|    |                                       |
    Off-|    +---------------------------------------+
	|
  1 On -|    +----+                             +----+
	|    |    |                             |    |
    Off |----+    +-----------------------------+    +--------
	|
  2 On -|         +----+                   +----+
	|         |    |                   |    |
    Off-|---------+    +-------------------+    +-------------
	|
  3 On -|              +----+         +----+
	|              |    |         |    |
    Off-|--------------+    +---------+    +------------------
	|
  4 On -|                   +---------+
	|                   |         |
    Off-|-------------------+         +-----------------------
	|
	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)

Inverted bounce mode for Pipe LED::

    "30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"

	^
	|
  0 On -|    +---------------------------------------+
	|    |                                       |
    Off-|----+                                       +--------
	|
  1 On -|----+    +-----------------------------+    +--------
	|    |    |                             |    |
    Off |    +----+                             +----+
	|
  2 On -|---------+    +-------------------+    +-------------
	|         |    |                   |    |
    Off-|         +----+                   +----+
	|
  3 On -|--------------+    +---------+    +------------------
	|              |    |         |    |
    Off-|              +----+         +----+
	|
  4 On -|-------------------+         +-----------------------
	|                   |         |
    Off-|                   +---------+
	|
	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
Commit	Line	Data
26a07553 MCC	1	.. SPDX-License-Identifier: GPL-2.0
	2
	3	==================================
	4	Kernel driver for Crane EL15203000
	5	==================================
	6
	7	/sys/class/leds/<led>/hw_pattern
	8	--------------------------------
	9
	10	Specify a hardware pattern for the EL15203000 LED.
	11
	12	The LEDs board supports only predefined patterns by firmware
	13	for specific LEDs.
	14
	15	Breathing mode for Screen frame light tube::
	16
	17	"0 4000 1 4000"
	18
	19	^
	20	\|
	21	Max-\| ---
	22	\| / \
	23	\| / \
	24	\| / \ /
	25	\| / \ /
	26	Min-\|- ---
	27	\|
	28	0------4------8--> time (sec)
	29
	30	Cascade mode for Pipe LED::
	31
	32	"1 800 2 800 4 800 8 800 16 800"
	33
	34	^
	35	\|
	36	0 On -\|----+ +----+ +---
	37	\| \| \| \| \|
	38	Off-\| +-------------------+ +-------------------+
	39	\|
	40	1 On -\| +----+ +----+
	41	\| \| \| \| \|
	42	Off \|----+ +-------------------+ +------------------
	43	\|
	44	2 On -\| +----+ +----+
	45	\| \| \| \| \|
	46	Off-\|---------+ +-------------------+ +-------------
	47	\|
	48	3 On -\| +----+ +----+
	49	\| \| \| \| \|
	50	Off-\|--------------+ +-------------------+ +--------
	51	\|
	52	4 On -\| +----+ +----+
	53	\| \| \| \| \|
	54	Off-\|-------------------+ +-------------------+ +---
	55	\|
	56	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
	57
	58	Inverted cascade mode for Pipe LED::
	59
	60	"30 800 29 800 27 800 23 800 15 800"
	61
	62	^
	63	\|
	64	0 On -\| +-------------------+ +-------------------+
65	\| \| \| \| \|
66	Off-\|----+ +----+ +---
67	\|
68	1 On -\|----+ +-------------------+ +------------------
69	\| \| \| \| \|
70	Off \| +----+ +----+
71	\|
72	2 On -\|---------+ +-------------------+ +-------------
73	\| \| \| \| \|
74	Off-\| +----+ +----+
75	\|
76	3 On -\|--------------+ +-------------------+ +--------
77	\| \| \| \| \|
78	Off-\| +----+ +----+
79	\|
80	4 On -\|-------------------+ +-------------------+ +---
81	\| \| \| \| \|
82	Off-\| +----+ +----+
83	\|
84	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
85
86	Bounce mode for Pipe LED::
87
88	"1 800 2 800 4 800 8 800 16 800 16 800 8 800 4 800 2 800 1 800"
89
90	^
91	\|
92	0 On -\|----+ +--------
93	\| \| \|
94	Off-\| +---------------------------------------+
95	\|
96	1 On -\| +----+ +----+
97	\| \| \| \| \|
98	Off \|----+ +-----------------------------+ +--------
99	\|
100	2 On -\| +----+ +----+
101	\| \| \| \| \|
102	Off-\|---------+ +-------------------+ +-------------
103	\|
104	3 On -\| +----+ +----+
105	\| \| \| \| \|
106	Off-\|--------------+ +---------+ +------------------
107	\|
108	4 On -\| +---------+
109	\| \| \|
110	Off-\|-------------------+ +-----------------------
111	\|
112	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)
113
114	Inverted bounce mode for Pipe LED::
115
116	"30 800 29 800 27 800 23 800 15 800 15 800 23 800 27 800 29 800 30 800"
117
118	^
119	\|
120	0 On -\| +---------------------------------------+
121	\| \| \|
122	Off-\|----+ +--------
123	\|
124	1 On -\|----+ +-----------------------------+ +--------
125	\| \| \| \| \|
126	Off \| +----+ +----+
127	\|
128	2 On -\|---------+ +-------------------+ +-------------
129	\| \| \| \| \|
130	Off-\| +----+ +----+
131	\|
132	3 On -\|--------------+ +---------+ +------------------
133	\| \| \| \| \|
134	Off-\| +----+ +----+
135	\|
136	4 On -\|-------------------+ +-----------------------
137	\| \| \|
138	Off-\| +---------+
139	\|
140	0---0.8--1.6--2.4--3.2---4---4.8--5.6--6.4--7.2---8--> time (sec)