LKML Archive on 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 02/19] leds: flash: document sysfs interface
Date: Wed, 04 Mar 2015 17:14:23 +0100	[thread overview]
Message-ID: <1425485680-8417-3-git-send-email-j.anaszewski@samsung.com> (raw)
In-Reply-To: <1425485680-8417-1-git-send-email-j.anaszewski@samsung.com>

Add a documentation of LED Flash class specific 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/ABI/testing/sysfs-class-led-flash |   80 +++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-led-flash

diff --git a/Documentation/ABI/testing/sysfs-class-led-flash b/Documentation/ABI/testing/sysfs-class-led-flash
new file mode 100644
index 0000000..220a027
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-led-flash
@@ -0,0 +1,80 @@
+What:		/sys/class/leds/<led>/flash_brightness
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read/write
+		Set the brightness of this LED in the flash strobe mode, in
+		microamperes. The file is created only for the flash LED devices
+		that support setting flash brightness.
+
+		The value is between 0 and
+		/sys/class/leds/<led>/max_flash_brightness.
+
+What:		/sys/class/leds/<led>/max_flash_brightness
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read only
+		Maximum brightness level for this LED in the flash strobe mode,
+		in microamperes.
+
+What:		/sys/class/leds/<led>/flash_timeout
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read/write
+		Hardware timeout for flash, in microseconds. The flash strobe
+		is stopped after this period of time has passed from the start
+		of the strobe. The file is created only for the flash LED
+		devices that support setting flash timeout.
+
+What:		/sys/class/leds/<led>/max_flash_timeout
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read only
+		Maximum flash timeout for this LED, in microseconds.
+
+What:		/sys/class/leds/<led>/flash_strobe
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read/write
+		Flash strobe state. When written with 1 it triggers flash strobe
+		and when written with 0 it turns the flash off.
+
+		On read 1 means that flash is currently strobing and 0 means
+		that flash is off.
+
+What:		/sys/class/leds/<led>/flash_fault
+Date:		March 2015
+KernelVersion:	4.0
+Contact:	Jacek Anaszewski <j.anaszewski@samsung.com>
+Description:	read only
+		Space separated list of flash faults that may have occurred.
+		Flash faults are re-read after strobing the flash. Possible
+		flash faults:
+
+		* led-over-voltage - flash controller voltage to the flash LED
+			has exceeded the limit specific to the flash controller
+		* flash-timeout-exceeded - the flash strobe was still on when
+			the timeout set by the user has expired; not all flash
+			controllers may set this in all such conditions
+		* controller-over-temperature - the flash controller has
+			overheated
+		* controller-short-circuit - the short circuit protection
+			of the flash controller has been triggered
+		* led-power-supply-over-current - current in the LED power
+			supply has exceeded the limit specific to the flash
+			controller
+		* indicator-led-fault - the flash controller has detected
+			a short or open circuit condition on the indicator LED
+		* led-under-voltage - flash controller voltage to the flash
+			LED has been below the minimum limit specific to
+			the flash
+		* controller-under-voltage - the input voltage of the flash
+			controller is below the limit under which strobing the
+			flash at full current will not be possible;
+			the condition persists until this flag is no longer set
+		* led-over-temperature - the temperature of the LED has exceeded
+			its allowed upper limit
-- 
1.7.9.5


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

Thread overview: 33+ 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 ` Jacek Anaszewski [this message]
2015-03-10  0:17   ` [PATCH/RFC v12 02/19] leds: flash: document sysfs interface Bryan Wu
2015-03-04 16:14 ` [PATCH/RFC v12 03/19] Documentation: leds: Add description of LED Flash class extension Jacek Anaszewski
2015-03-10  0:23   ` 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
2015-03-04 16:14 ` [PATCH/RFC v12 06/19] mfd: max77693: Remove struct max77693_led_platform_data 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
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-3-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 \
    --subject='Re: [PATCH/RFC v12 02/19] leds: flash: document sysfs interface' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).