All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jacek Anaszewski <j.anaszewski@samsung.com>
To: linux-leds@vger.kernel.org, linux-media@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	kyungmin.park@samsung.com, pavel@ucw.cz, cooloney@gmail.com,
	rpurdie@rpsys.net, sakari.ailus@iki.fi, s.nawrocki@samsung.com,
	Jacek Anaszewski <j.anaszewski@samsung.com>
Subject: [PATCH/RFC v12 03/19] Documentation: leds: Add description of LED Flash class extension
Date: Wed, 04 Mar 2015 17:14:24 +0100	[thread overview]
Message-ID: <1425485680-8417-4-git-send-email-j.anaszewski@samsung.com> (raw)
In-Reply-To: <1425485680-8417-1-git-send-email-j.anaszewski@samsung.com>

The documentation being added contains overall description of the
LED Flash Class and the related sysfs attributes.

Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
Acked-by: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Bryan Wu <cooloney@gmail.com>
Cc: Richard Purdie <rpurdie@rpsys.net>
---
 Documentation/leds/leds-class-flash.txt |   22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 Documentation/leds/leds-class-flash.txt

diff --git a/Documentation/leds/leds-class-flash.txt b/Documentation/leds/leds-class-flash.txt
new file mode 100644
index 0000000..19bb673
--- /dev/null
+++ b/Documentation/leds/leds-class-flash.txt
@@ -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
-- 
1.7.9.5

  parent reply	other threads:[~2015-03-04 16:14 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-04 16:14 [PATCH/RFC v12 00/19] LED / flash API integration Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 01/19] leds: flash: Remove synchronized flash strobe feature Jacek Anaszewski
2015-03-09 23:23   ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 02/19] leds: flash: document sysfs interface Jacek Anaszewski
2015-03-10  0:17   ` Bryan Wu
2015-03-04 16:14 ` Jacek Anaszewski [this message]
2015-03-10  0:23   ` [PATCH/RFC v12 03/19] Documentation: leds: Add description of LED Flash class extension Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 04/19] dt-binding: leds: Add common LED DT bindings macros Jacek Anaszewski
2015-03-05  7:56   ` Jacek Anaszewski
2015-03-10  0:33     ` Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 05/19] mfd: max77693: Modify flash cell name identifiers Jacek Anaszewski
2015-03-09  9:36   ` Lee Jones
     [not found] ` <1425485680-8417-1-git-send-email-j.anaszewski-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org>
2015-03-04 16:14   ` [PATCH/RFC v12 06/19] mfd: max77693: Remove struct max77693_led_platform_data Jacek Anaszewski
2015-03-04 16:14     ` Jacek Anaszewski
2015-03-09  9:35     ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 07/19] mfd: max77693: add TORCH_IOUT_MASK macro Jacek Anaszewski
2015-03-09  9:36   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 08/19] mfd: max77693: Adjust FLASH_EN_SHIFT and TORCH_EN_SHIFT macros Jacek Anaszewski
2015-03-09  9:35   ` Lee Jones
2015-03-04 16:14 ` [PATCH/RFC v12 09/19] leds: Add support for max77693 mfd flash cell Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 10/19] DT: Add documentation for the mfd Maxim max77693 Jacek Anaszewski
     [not found]   ` <1425485680-8417-11-git-send-email-j.anaszewski-Sze3O3UU22JBDgjK7y7TUQ@public.gmane.org>
2015-03-09 10:54     ` Sakari Ailus
2015-03-09 10:54       ` Sakari Ailus
2015-03-09 12:19       ` Jacek Anaszewski
2015-03-09 12:37         ` Sakari Ailus
2015-03-09 13:45           ` Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 11/19] leds: Add driver for AAT1290 current regulator Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 12/19] of: Add Skyworks Solutions, Inc. vendor prefix Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 13/19] DT: Add documentation for the Skyworks AAT1290 Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 14/19] exynos4-is: Add support for v4l2-flash subdevs Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 15/19] media: Add registration helpers for V4L2 flash sub-devices Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 16/19] Documentation: leds: Add description of v4l2-flash sub-device Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 17/19] DT: Add documentation for exynos4-is 'flashes' property Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 18/19] leds: max77693: add support for V4L2 Flash sub-device Jacek Anaszewski
2015-03-04 16:14 ` [PATCH/RFC v12 19/19] leds: aat1290: " Jacek Anaszewski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1425485680-8417-4-git-send-email-j.anaszewski@samsung.com \
    --to=j.anaszewski@samsung.com \
    --cc=cooloney@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=kyungmin.park@samsung.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=rpurdie@rpsys.net \
    --cc=s.nawrocki@samsung.com \
    --cc=sakari.ailus@iki.fi \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.