cff8431bf4
This one is challenging as both the places this appears in specific drivers are making 'unusual' uses of what looks like a simple output current channel. As a side note, this was particular bit of ABI occurs in other drivers where the use is much more straight forward e.g. dac/ad5421 This patch attempts to make a best effort of adding it to the main docs but retaining enough information. Both of these drivers probably need specific documents being written to describe their unusual interfaces, but those should be in the main documentation, not under Documentation/ABI. That is a non trivial job so left for another time. Fixes $ scripts/get_abi.pl validate Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 ./Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38 Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Link: https://lore.kernel.org/r/20210117153816.696693-5-jic23@kernel.org
1.8 KiB
What: /sys/.../events/in_illuminance0_thresh_either_en Date: April 2012 KernelVersion: 3.5 Contact: Johan Hovold jhovold@gmail.com Description: Event generated when channel passes one of the four thresholds in each direction (rising|falling) and a zone change occurs. The corresponding light zone can be read from in_illuminance0_zone.
What: /sys/.../events/in_illuminance0_threshY_hysteresis Date: May 2012 KernelVersion: 3.5 Contact: Johan Hovold jhovold@gmail.com Description: Get the hysteresis for thresholds Y, that is, threshY_hysteresis = threshY_raising - threshY_falling
What: /sys/.../events/illuminance_threshY_falling_value What: /sys/.../events/illuminance_threshY_raising_value Date: April 2012 KernelVersion: 3.5 Contact: Johan Hovold jhovold@gmail.com Description: Specifies the value of threshold that the device is comparing against for the events enabled by in_illuminance0_thresh_either_en (0..255), where Y in 0..3.
Note that threshY_falling must be less than or equal to
threshY_raising.
These thresholds correspond to the eight zone-boundary
registers (boundaryY_{low,high}) and define the five light
zones.
What: /sys/bus/iio/devices/iio:deviceX/in_illuminance0_zone Date: April 2012 KernelVersion: 3.5 Contact: Johan Hovold jhovold@gmail.com Description: Get the current light zone (0..4) as defined by the in_illuminance0_threshY_{falling,rising} thresholds.
What: /sys/bus/iio/devices/iio:deviceX/out_currentY_currentZ_raw Date: May 2012 KernelVersion: 3.5 Contact: Johan Hovold jhovold@gmail.com Description: Set the output current for channel out_currentY when in zone Z (0..255), where Y in 0..2 and Z in 0..4.
These values correspond to the ALS-mapper target registers for
ALS-mapper Y + 1.
Note that out_currentY_raw provides the current for the
current zone.