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