Skip to contentSkip to conversation

iio: documentation: light: Add veml6030 sysfs documentation

PATCH Superseded Rishi Gupta 2 participants 3 messages Oct 22, 2019 – Oct 27, 2019 IIO

v5 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

PATCH v5 3/3 iio: documentation: light: Add veml6030 sysfs documentation

The driver for veml6030 light sensor provides sysfs entries like configuring cutoff for interrupt. This commit document them.

---
Changes in v5:
* Use ABI/testing/sysfs-bus-iio to document sysfs files for veml6030

Changes in v4:
* None

Changes in v3:
* Updated Date from September to October
* Updated KernelVersion from 5.3.1 to 5.4
* in_illuminance_period_available is now in events directory

Changes in v2:
* None

 Documentation/ABI/testing/sysfs-bus-iio | 12 ++++++++++++
 1 file changed, 12 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +12 -0
index 6804516..a26d532 100644
@@ -753,6 +753,8 @@ What:		/sys/.../events/in_illuminance0_thresh_falling_value
 what:		/sys/.../events/in_illuminance0_thresh_rising_value
 what:		/sys/.../events/in_proximity0_thresh_falling_value
 what:		/sys/.../events/in_proximity0_thresh_rising_value
+What:		/sys/.../events/in_illuminance_thresh_rising_value
+What:		/sys/.../events/in_illuminance_thresh_falling_value
 KernelVersion:	2.6.37
 Contact:	[email protected]
 Description:
@@ -972,6 +974,7 @@ What:		/sys/.../events/in_activity_jogging_thresh_rising_period
 What:		/sys/.../events/in_activity_jogging_thresh_falling_period
 What:		/sys/.../events/in_activity_running_thresh_rising_period
 What:		/sys/.../events/in_activity_running_thresh_falling_period
+What:		/sys/.../events/in_illuminance_thresh_either_period
 KernelVersion:	2.6.37
 Contact:	[email protected]
 Description:
@@ -1715,3 +1718,12 @@ Description:
 		Mass concentration reading of particulate matter in ug / m3.
 		pmX consists of particles with aerodynamic diameter less or
 		equal to X micrometers.
+
+What:		/sys/bus/iio/devices/iio:deviceX/events/in_illuminance_period_available
+Date:		October 2019
+KernelVersion:	5.4
+Contact:	[email protected]
+Description:
+		List of valid values available in multiples of integration time
+		for which the light intensity must be above the threshold level
+		before interrupt is asserted. This refers to persistence values.
Signature · 1 line
2.7.4
#1 lore raw

Forget to capture in change log:
removed PSM sysfs completely.

Quoted 61 lines · Rishi Gupta

The driver for veml6030 light sensor provides sysfs entries like configuring cutoff for interrupt. This commit document them.

---
Changes in v5:
* Use ABI/testing/sysfs-bus-iio to document sysfs files for veml6030

Changes in v4:
* None

Changes in v3:
* Updated Date from September to October
* Updated KernelVersion from 5.3.1 to 5.4
* in_illuminance_period_available is now in events directory

Changes in v2:
* None

 Documentation/ABI/testing/sysfs-bus-iio | 12 ++++++++++++
 1 file changed, 12 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +12 -1
index 6804516..a26d532 100644
@@ -753,6 +753,8 @@ What:               /sys/.../events/in_illuminance0_thresh_falling_value
 what:          /sys/.../events/in_illuminance0_thresh_rising_value
 what:          /sys/.../events/in_proximity0_thresh_falling_value
 what:          /sys/.../events/in_proximity0_thresh_rising_value
+What:          /sys/.../events/in_illuminance_thresh_rising_value
+What:          /sys/.../events/in_illuminance_thresh_falling_value
 KernelVersion: 2.6.37
 Contact:       [email protected]
 Description:
@@ -972,6 +974,7 @@ What:               /sys/.../events/in_activity_jogging_thresh_rising_period
 What:          /sys/.../events/in_activity_jogging_thresh_falling_period
 What:          /sys/.../events/in_activity_running_thresh_rising_period
 What:          /sys/.../events/in_activity_running_thresh_falling_period
+What:          /sys/.../events/in_illuminance_thresh_either_period
 KernelVersion: 2.6.37
 Contact:       [email protected]
 Description:
@@ -1715,3 +1718,12 @@ Description:
                Mass concentration reading of particulate matter in ug / m3.
                pmX consists of particles with aerodynamic diameter less or
                equal to X micrometers.
+
+What:          /sys/bus/iio/devices/iio:deviceX/events/in_illuminance_period_available
+Date:          October 2019
+KernelVersion: 5.4
+Contact:       [email protected]
+Description:
+               List of valid values available in multiples of integration time
+               for which the light intensity must be above the threshold level
+               before interrupt is asserted. This refers to persistence values.
--

2.7.4

maintainer
#2 lore raw
In reply to Rishi Gupta
Quoted 47 lines · On Tue, 22 Oct 2019 18:41:27 +0530 Rishi Gupta <[email protected]> wrote:

The driver for veml6030 light sensor provides sysfs entries like configuring cutoff for interrupt. This commit document them.

---
Changes in v5:
* Use ABI/testing/sysfs-bus-iio to document sysfs files for veml6030

Changes in v4:
* None

Changes in v3:
* Updated Date from September to October
* Updated KernelVersion from 5.3.1 to 5.4
* in_illuminance_period_available is now in events directory

Changes in v2:
* None

 Documentation/ABI/testing/sysfs-bus-iio | 12 ++++++++++++
 1 file changed, 12 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +3 -0
index 6804516..a26d532 100644
@@ -753,6 +753,8 @@ What:		/sys/.../events/in_illuminance0_thresh_falling_value
 what:		/sys/.../events/in_illuminance0_thresh_rising_value
 what:		/sys/.../events/in_proximity0_thresh_falling_value
 what:		/sys/.../events/in_proximity0_thresh_rising_value
+What:		/sys/.../events/in_illuminance_thresh_rising_value
+What:		/sys/.../events/in_illuminance_thresh_falling_value
 KernelVersion:	2.6.37
 Contact:	[email protected]
 Description:
@@ -972,6 +974,7 @@ What:		/sys/.../events/in_activity_jogging_thresh_rising_period
 What:		/sys/.../events/in_activity_jogging_thresh_falling_period
 What:		/sys/.../events/in_activity_running_thresh_rising_period
 What:		/sys/.../events/in_activity_running_thresh_falling_period
+What:		/sys/.../events/in_illuminance_thresh_either_period
 KernelVersion:	2.6.37
 Contact:	[email protected]
 Description:
@@ -1715,3 +1718,12 @@ Description:
 		Mass concentration reading of particulate matter in ug / m3.
 		pmX consists of particles with aerodynamic diameter less or

Documentation/ABI/testing/sysfs-bus-iio Description: · line 1729

Quoted 10 lines
Documentation/ABI/testing/sysfs-bus-iio +9 -0
 		equal to X micrometers.
+
+What:		/sys/bus/iio/devices/iio:deviceX/events/in_illuminance_period_available
+Date:		October 2019
+KernelVersion:	5.4
+Contact:	[email protected]
+Description:
+		List of valid values available in multiples of integration time
+		for which the light intensity must be above the threshold level
+		before interrupt is asserted. This refers to persistence values.

This doesn't match with in_illuminance_period (which is correct). The period values a are in seconds, not multiples of the integration time. The reason is that firstly integration time may not be related to sampling frequency (which actually matters here) and secondly it's much easier for userspace to set these period values to say something is true for 0.1 seconds rather than having to work out the relationship with the devices internal sampling rates.

Thanks,

Jonathan