xref: /openbmc/linux/Documentation/ABI/testing/sysfs-class-led-flash (revision cdd38c5f1ce4398ec58fec95904b75824daab7b5)
19c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/flash_brightness
29c4a8e13SJacek AnaszewskiDate:		March 2015
39c4a8e13SJacek AnaszewskiKernelVersion:	4.0
49c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
59c4a8e13SJacek AnaszewskiDescription:	read/write
69c4a8e13SJacek Anaszewski		Set the brightness of this LED in the flash strobe mode, in
79c4a8e13SJacek Anaszewski		microamperes. The file is created only for the flash LED devices
89c4a8e13SJacek Anaszewski		that support setting flash brightness.
99c4a8e13SJacek Anaszewski
109c4a8e13SJacek Anaszewski		The value is between 0 and
119c4a8e13SJacek Anaszewski		/sys/class/leds/<led>/max_flash_brightness.
129c4a8e13SJacek Anaszewski
139c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/max_flash_brightness
149c4a8e13SJacek AnaszewskiDate:		March 2015
159c4a8e13SJacek AnaszewskiKernelVersion:	4.0
169c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
179c4a8e13SJacek AnaszewskiDescription:	read only
189c4a8e13SJacek Anaszewski		Maximum brightness level for this LED in the flash strobe mode,
199c4a8e13SJacek Anaszewski		in microamperes.
209c4a8e13SJacek Anaszewski
219c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/flash_timeout
229c4a8e13SJacek AnaszewskiDate:		March 2015
239c4a8e13SJacek AnaszewskiKernelVersion:	4.0
249c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
259c4a8e13SJacek AnaszewskiDescription:	read/write
269c4a8e13SJacek Anaszewski		Hardware timeout for flash, in microseconds. The flash strobe
279c4a8e13SJacek Anaszewski		is stopped after this period of time has passed from the start
289c4a8e13SJacek Anaszewski		of the strobe. The file is created only for the flash LED
299c4a8e13SJacek Anaszewski		devices that support setting flash timeout.
309c4a8e13SJacek Anaszewski
319c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/max_flash_timeout
329c4a8e13SJacek AnaszewskiDate:		March 2015
339c4a8e13SJacek AnaszewskiKernelVersion:	4.0
349c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
359c4a8e13SJacek AnaszewskiDescription:	read only
369c4a8e13SJacek Anaszewski		Maximum flash timeout for this LED, in microseconds.
379c4a8e13SJacek Anaszewski
389c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/flash_strobe
399c4a8e13SJacek AnaszewskiDate:		March 2015
409c4a8e13SJacek AnaszewskiKernelVersion:	4.0
419c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
429c4a8e13SJacek AnaszewskiDescription:	read/write
439c4a8e13SJacek Anaszewski		Flash strobe state. When written with 1 it triggers flash strobe
449c4a8e13SJacek Anaszewski		and when written with 0 it turns the flash off.
459c4a8e13SJacek Anaszewski
469c4a8e13SJacek Anaszewski		On read 1 means that flash is currently strobing and 0 means
479c4a8e13SJacek Anaszewski		that flash is off.
489c4a8e13SJacek Anaszewski
499c4a8e13SJacek AnaszewskiWhat:		/sys/class/leds/<led>/flash_fault
509c4a8e13SJacek AnaszewskiDate:		March 2015
519c4a8e13SJacek AnaszewskiKernelVersion:	4.0
529c4a8e13SJacek AnaszewskiContact:	Jacek Anaszewski <j.anaszewski@samsung.com>
539c4a8e13SJacek AnaszewskiDescription:	read only
549c4a8e13SJacek Anaszewski		Space separated list of flash faults that may have occurred.
559c4a8e13SJacek Anaszewski		Flash faults are re-read after strobing the flash. Possible
569c4a8e13SJacek Anaszewski		flash faults:
579c4a8e13SJacek Anaszewski
58*54a19b4dSMauro Carvalho Chehab		* led-over-voltage
59*54a19b4dSMauro Carvalho Chehab			flash controller voltage to the flash LED
609c4a8e13SJacek Anaszewski			has exceeded the limit specific to the flash controller
61*54a19b4dSMauro Carvalho Chehab		* flash-timeout-exceeded
62*54a19b4dSMauro Carvalho Chehab			the flash strobe was still on when
639c4a8e13SJacek Anaszewski			the timeout set by the user has expired; not all flash
649c4a8e13SJacek Anaszewski			controllers may set this in all such conditions
65*54a19b4dSMauro Carvalho Chehab		* controller-over-temperature
66*54a19b4dSMauro Carvalho Chehab			the flash controller has
679c4a8e13SJacek Anaszewski			overheated
68*54a19b4dSMauro Carvalho Chehab		* controller-short-circuit
69*54a19b4dSMauro Carvalho Chehab			the short circuit protection
709c4a8e13SJacek Anaszewski			of the flash controller has been triggered
71*54a19b4dSMauro Carvalho Chehab		* led-power-supply-over-current
72*54a19b4dSMauro Carvalho Chehab			current in the LED power
739c4a8e13SJacek Anaszewski			supply has exceeded the limit specific to the flash
749c4a8e13SJacek Anaszewski			controller
75*54a19b4dSMauro Carvalho Chehab		* indicator-led-fault
76*54a19b4dSMauro Carvalho Chehab			the flash controller has detected
779c4a8e13SJacek Anaszewski			a short or open circuit condition on the indicator LED
78*54a19b4dSMauro Carvalho Chehab		* led-under-voltage
79*54a19b4dSMauro Carvalho Chehab			flash controller voltage to the flash
809c4a8e13SJacek Anaszewski			LED has been below the minimum limit specific to
819c4a8e13SJacek Anaszewski			the flash
82*54a19b4dSMauro Carvalho Chehab		* controller-under-voltage
83*54a19b4dSMauro Carvalho Chehab			the input voltage of the flash
849c4a8e13SJacek Anaszewski			controller is below the limit under which strobing the
859c4a8e13SJacek Anaszewski			flash at full current will not be possible;
869c4a8e13SJacek Anaszewski			the condition persists until this flag is no longer set
87*54a19b4dSMauro Carvalho Chehab		* led-over-temperature
88*54a19b4dSMauro Carvalho Chehab			the temperature of the LED has exceeded
899c4a8e13SJacek Anaszewski			its allowed upper limit
90