Skip to content

Commit

Permalink
Documentation: leds: Add description of LED Flash class extension
Browse files Browse the repository at this point in the history
The documentation being added contains overall description of the
LED Flash Class and the related sysfs attributes.

Signed-off-by: Jacek Anaszewski <[email protected]>
Acked-by: Kyungmin Park <[email protected]>
Cc: Richard Purdie <[email protected]>
Signed-off-by: Bryan Wu <[email protected]>
  • Loading branch information
janaszewski authored and cooloney committed Mar 10, 2015
1 parent 9c4a8e1 commit f6ad395
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Documentation/leds/leds-class-flash.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

Flash LED handling under Linux
==============================

Some LED devices provide two modes - torch and flash. In the LED subsystem
those modes are supported by LED class (see Documentation/leds/leds-class.txt)
and LED Flash class respectively. The torch mode related features are enabled
by default and the flash ones only if a driver declares it by setting
LED_DEV_CAP_FLASH flag.

In order to enable the support for flash LEDs CONFIG_LEDS_CLASS_FLASH symbol
must be defined in the kernel config. A LED Flash class driver must be
registered in the LED subsystem with led_classdev_flash_register function.

Following sysfs attributes are exposed for controlling flash LED devices:
(see Documentation/ABI/testing/sysfs-class-led-flash)
- flash_brightness
- max_flash_brightness
- flash_timeout
- max_flash_timeout
- flash_strobe
- flash_fault

0 comments on commit f6ad395

Please sign in to comment.