xref: /linux/Documentation/ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar (revision 71e2f4dd5a65bd8dbca0b77661e75eea471168f8)
1What:		/sys/class/chromeos/<ec-device-name>/lightbar/brightness
2Date:		August 2015
3KernelVersion:	4.2
4Description:
5		Writing to this file adjusts the overall brightness of
6		the lightbar, separate from any color intensity. The
7		valid range is 0 (off) to 255 (maximum brightness).
8
9What:		/sys/class/chromeos/<ec-device-name>/lightbar/interval_msec
10Date:		August 2015
11KernelVersion:	4.2
12Description:
13		The lightbar is controlled by an embedded controller (EC),
14		which also manages the keyboard, battery charging, fans,
15		and other system hardware. To prevent unprivileged users
16		from interfering with the other EC functions, the rate at
17		which the lightbar control files can be read or written is
18		limited.
19
20		Reading this file will return the number of milliseconds
21		that must elapse between accessing any of the lightbar
22		functions through this interface. Going faster will simply
23		block until the necessary interval has lapsed. The interval
24		applies uniformly to all accesses of any kind by any user.
25
26What:		/sys/class/chromeos/<ec-device-name>/lightbar/led_rgb
27Date:		August 2015
28KernelVersion:	4.2
29Description:
30		This allows you to control each LED segment. If the
31		lightbar is already running one of the automatic
32		sequences, you probably won’t see anything change because
33		your color setting will be almost immediately replaced.
34		To get useful results, you should stop the lightbar
35		sequence first.
36
37		The values written to this file are sets of four integers,
38		indicating LED, RED, GREEN, BLUE. The LED number is 0 to 3
39		to select a single segment, or 4 to set all four segments
40		to the same value at once. The RED, GREEN, and BLUE
41		numbers should be in the range 0 (off) to 255 (maximum).
42		You can update more than one segment at a time by writing
43		more than one set of four integers.
44
45What:		/sys/class/chromeos/<ec-device-name>/lightbar/program
46Date:		August 2015
47KernelVersion:	4.2
48Description:
49		This allows you to upload and run custom lightbar sequences.
50
51What:		/sys/class/chromeos/<ec-device-name>/lightbar/sequence
52Date:		August 2015
53KernelVersion:	4.2
54Description:
55		The Pixel lightbar has a number of built-in sequences
56		that it displays under various conditions, such as at
57		power on, shut down, or while running. Reading from this
58		file displays the current sequence that the lightbar is
59		displaying. Writing to this file allows you to change the
60		sequence.
61
62What:		/sys/class/chromeos/<ec-device-name>/lightbar/userspace_control
63Date:		August 2015
64KernelVersion:	4.2
65Description:
66		This allows you to take the control of the lightbar. This
67		prevents the kernel from going through its normal
68		sequences.
69
70What:		/sys/class/chromeos/<ec-device-name>/lightbar/version
71Date:		August 2015
72KernelVersion:	4.2
73Description:
74		Show the information about the lightbar version.
75