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