iio: Expand IIO event interface for real-world unit handling
Subsystems (3)
cover iio: Expand IIO event interface for real-world unit handling
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide _input threshold value attributes.
I'm actually proposing this set just for the sake of solving the event ABI naming inconsistency. I recall the event ABI was a bit puzzling to understand when I was having a closer look at that a while ago [1].
[1]: https://lore.kernel.org/linux-iio/[email protected]/
Also, I'm doing this set entirely on my spare time and just because I wanted to have the ABI naming inconsistency fixed. This is also a late reply to [2]. [2]: https://lore.kernel.org/linux-iio/20251109164312.781de64c@jic23-huawei/
I've tested this with ad7091r8 driver and result is:
Before event extension (current IIO teting branch):
root@localhost:~# ls /sys/bus/iio/devices/iio:device0/events in_voltage0_thresh_either_hysteresis in_voltage4_thresh_either_hysteresis in_voltage0_thresh_falling_en in_voltage4_thresh_falling_en in_voltage0_thresh_falling_value in_voltage4_thresh_falling_value in_voltage0_thresh_rising_en in_voltage4_thresh_rising_en in_voltage0_thresh_rising_value in_voltage4_thresh_rising_value in_voltage1_thresh_either_hysteresis in_voltage5_thresh_either_hysteresis in_voltage1_thresh_falling_en in_voltage5_thresh_falling_en in_voltage1_thresh_falling_value in_voltage5_thresh_falling_value in_voltage1_thresh_rising_en in_voltage5_thresh_rising_en in_voltage1_thresh_rising_value in_voltage5_thresh_rising_value in_voltage2_thresh_either_hysteresis in_voltage6_thresh_either_hysteresis in_voltage2_thresh_falling_en in_voltage6_thresh_falling_en in_voltage2_thresh_falling_value in_voltage6_thresh_falling_value in_voltage2_thresh_rising_en in_voltage6_thresh_rising_en in_voltage2_thresh_rising_value in_voltage6_thresh_rising_value in_voltage3_thresh_either_hysteresis in_voltage7_thresh_either_hysteresis in_voltage3_thresh_falling_en in_voltage7_thresh_falling_en in_voltage3_thresh_falling_value in_voltage7_thresh_falling_value in_voltage3_thresh_rising_en in_voltage7_thresh_rising_en in_voltage3_thresh_rising_value in_voltage7_thresh_rising_value
After event extension:
root@localhost:~# ls /sys/bus/iio/devices/iio:device0/events in_voltage0_raw_thresh_either_hysteresis in_voltage4_raw_thresh_either_hysteresis in_voltage0_raw_thresh_falling_value in_voltage4_raw_thresh_falling_value in_voltage0_raw_thresh_rising_value in_voltage4_raw_thresh_rising_value in_voltage0_thresh_falling_en in_voltage4_thresh_falling_en in_voltage0_thresh_rising_en in_voltage4_thresh_rising_en in_voltage1_raw_thresh_either_hysteresis in_voltage5_raw_thresh_either_hysteresis in_voltage1_raw_thresh_falling_value in_voltage5_raw_thresh_falling_value in_voltage1_raw_thresh_rising_value in_voltage5_raw_thresh_rising_value in_voltage1_thresh_falling_en in_voltage5_thresh_falling_en in_voltage1_thresh_rising_en in_voltage5_thresh_rising_en in_voltage2_raw_thresh_either_hysteresis in_voltage6_raw_thresh_either_hysteresis in_voltage2_raw_thresh_falling_value in_voltage6_raw_thresh_falling_value in_voltage2_raw_thresh_rising_value in_voltage6_raw_thresh_rising_value in_voltage2_thresh_falling_en in_voltage6_thresh_falling_en in_voltage2_thresh_rising_en in_voltage6_thresh_rising_en in_voltage3_raw_thresh_either_hysteresis in_voltage7_raw_thresh_either_hysteresis in_voltage3_raw_thresh_falling_value in_voltage7_raw_thresh_falling_value in_voltage3_raw_thresh_rising_value in_voltage7_raw_thresh_rising_value in_voltage3_thresh_falling_en in_voltage7_thresh_falling_en in_voltage3_thresh_rising_en in_voltage7_thresh_rising_en
The difference is the '_raw' element in thresh_(rising|falling|either) attributes.
Why posting it as an RFC?
1) ABI changes a sensitive topic.
2) There are 77 drivers that will go through collateral evolution with the event interface update. A 77+ patch set is probably not a good idea? I recall the claim_direct stuff was split into 2 or more patch sets. This might need a similar approach (if accepted).
3) My coccinelle semantic patch does a nice job in updating the vast majority of the drivers but, it produces diffs longer than needed. E.g.
@@ -844,7 +844,8 @@ static int adxl313_read_event_value(stru
enum iio_event_type type, enum iio_event_direction dir, enum iio_event_info info,
- int *val, int *val2) + enum iio_event_unit unit, int *val, + int *val2)
could be
@@ -844,6 +844,7 @@ static int adxl313_read_event_value(struct iio_dev *indio_dev,
enum iio_event_type type,
enum iio_event_direction dir, enum iio_event_info info,
+ enum iio_event_unit unit,
int *val, int *val2)
I'll try to figure out how to make it generate smaller diffs, or do the changes by hand if needed.
One more thing is this doesn't need to take test bot time as this breaks kernel build without the patches to the individual drivers.
With best regards,
Marcelo
Marcelo Schmitt (9):
iio: ABI: Drop unused in_energy_input
iio: ABI: Accurately describe in_distance_input
iio: ABI: Accurately describe in_illuminance[Y]_input
iio: ABI: Slight readability improve for event threshold value doc
iio: ABI: Update event threshold value documentation
iio: ABI: Adjust event threshold enable desc to unitless thresh values
iio: Expand IIO event interface for real-world unit handling
iio: dummy: iio_simple_dummy: Update to event unit expanded interface
iio: adc: ad7091r-base: Update to event unit expanded interface
Documentation/ABI/testing/sysfs-bus-iio | 29 +++++++++---- drivers/iio/adc/ad7091r-base.c | 7 ++- drivers/iio/dummy/iio_simple_dummy.h | 6 ++- drivers/iio/dummy/iio_simple_dummy_events.c | 2 + drivers/iio/industrialio-event.c | 47 +++++++++++++++------ include/linux/iio/iio.h | 8 +++- include/uapi/linux/iio/types.h | 5 +++ 7 files changed, 77 insertions(+), 27 deletions(-)
base-commit: c30e80d68a7afb334fde7147ee0106f25dd58d3a
Signature · 1 line
2.51.0
RFC PATCH 1/9 iio: ABI: Drop unused in_energy_input
No IIO driver declares a channel of type IIO_ENERGY with info_mask containing IIO_CHAN_INFO_PROCESSED. Thus, in_energy_input has never been seen in user space.
---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?
Documentation/ABI/testing/sysfs-bus-iio | 1 - 1 file changed, 1 deletion(-)
Documentation/ABI/testing/sysfs-bus-iio +0 -1
@@ -1601,7 +1601,6 @@ Description: For a list of available output power modes read in_accel_power_mode_available. -What: /sys/.../iio:deviceX/in_energy_input What: /sys/.../iio:deviceX/in_energy_raw What: /sys/.../iio:deviceX/in_energyY_active_raw What: /sys/.../iio:deviceX/in_energyY_reactive_raw
Signature · 1 line
2.51.0
RFC PATCH 2/9 iio: ABI: Accurately describe in_distance_input
In reply to Marcelo SchmittThere is only one driver (drivers/iio/accel/mma9553.c) that declares a channel of type IIO_DISTANCE with an info_mask containing IIO_CHAN_INFO_PROCESSED. Though, mma9553.c provides distance in meters (as would be expected for the _input interface). Split in_distance_raw and in_distance_input ABI documentation to provide accurate description for the in_distance_input interface.
---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?
Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++ 1 file changed, 7 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +7 -0
@@ -1613,6 +1613,13 @@ Description: user). Units after application of scale are Joules. What: /sys/.../iio:deviceX/in_distance_input +KernelVersion: 4.0 +Contact: [email protected] +Description: + This attribute is used to read the measured distance (in meters) + to an object or the distance covered by the user since the last + reboot while activated. + What: /sys/.../iio:deviceX/in_distance_raw KernelVersion: 4.0 Contact: [email protected]
Signature · 1 line
2.51.0
RFC PATCH 3/9 iio: ABI: Accurately describe in_illuminance[Y]_input
In reply to Marcelo SchmittThe drivers that provide channels of type IIO_LIGHT with info masks containing IIO_CHAN_INFO_PROCESSED provide values in lux through their in_illuminance[Y]_input attribute. A few drivers provide both in_illuminance[Y]_raw and in_illuminance[Y]_input and those also provide values in lux through in_illuminance[Y]_input (as one would expect from _input interfaces). The documentation, though, was previously describing in_illuminance[Y]_input attributes as if they would only provide values in lux after the application of offset and scale. Adjust the docs to provide accurate description for IIO channel in_illuminance[Y]_input interface.
--- Documentation/ABI/testing/sysfs-bus-iio | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-bus-iio +6 -1
@@ -1652,8 +1652,13 @@ Description: application of scale and offset are meters. What: /sys/.../iio:deviceX/in_illuminance_input -What: /sys/.../iio:deviceX/in_illuminance_raw What: /sys/.../iio:deviceX/in_illuminanceY_input +KernelVersion: 3.4 +Contact: [email protected] +Description: + Illuminance measurement in lux. + +What: /sys/.../iio:deviceX/in_illuminance_raw What: /sys/.../iio:deviceX/in_illuminanceY_raw What: /sys/.../iio:deviceX/in_illuminanceY_mean_raw What: /sys/.../iio:deviceX/in_illuminance_ir_raw
Signature · 1 line
2.51.0
RFC PATCH 4/9 iio: ABI: Slight readability improve for event threshold value doc
In reply to Marcelo SchmittAdd missing '_' to the attribute name pattern. While at it, add a word to clarify the relation with the configuration enable attribute on specific scenarios.
--- Documentation/ABI/testing/sysfs-bus-iio | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-bus-iio +2 -2
@@ -1054,9 +1054,9 @@ Contact: [email protected] Description: Specifies the value of threshold that the device is comparing against for the events enabled by - <type>Y[_name]_thresh[_rising|falling]_en. + <type>Y[_name]_thresh[_rising|_falling]_en. - If separate attributes exist for the two directions, but + If separate enable attributes exist for the two directions, but direction is not specified for this attribute, then a single threshold value applies to both directions.
Signature · 1 line
2.51.0
RFC PATCH 5/9 iio: ABI: Update event threshold value documentation
In reply to Marcelo SchmittComplement the IIO event threshold value ABI description clarifying that raw device units are assumed when the attribute has no _raw/_input element in it's name.
--- Documentation/ABI/testing/sysfs-bus-iio | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-bus-iio +3 -1
@@ -1062,7 +1062,9 @@ Description: The raw or input element of the name indicates whether the value is in raw device units or in processed units (as _raw - and _input do on sysfs direct channel read attributes). + and _input do on sysfs direct channel read attributes). If the + raw/input element of the name is absent, values are in raw + device units. What: /sys/.../events/in_accel_scale What: /sys/.../events/in_accel_peak_scale
Signature · 1 line
2.51.0
RFC PATCH 6/9 iio: ABI: Adjust event threshold enable desc to unitless thresh values
In reply to Marcelo SchmittAdjust the event threshold enable attribute description to cover the cases where threshold value attributes don't contain a _raw/_input element in their names.
--- Documentation/ABI/testing/sysfs-bus-iio | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-bus-iio +3 -3
@@ -906,9 +906,9 @@ Description: (_rising|_falling) direction. If the direction is not specified, then either the device will report an event which ever direction a single threshold value is passed in (e.g. - <type>[Y][_name]_<raw|input>_thresh_value) or - <type>[Y][_name]_<raw|input>_thresh_rising_value and - <type>[Y][_name]_<raw|input>_thresh_falling_value may take + <type>[Y][_name][_raw|_input]_thresh_value) or + <type>[Y][_name][_raw|_input]_thresh_rising_value and + <type>[Y][_name][_raw|_input]_thresh_falling_value may take different values, but the device can only enable both thresholds or neither.
Signature · 1 line
2.51.0
RFC PATCH 7/9 iio: Expand IIO event interface for real-world unit handling
In reply to Marcelo SchmittThe IIO event ABI documentation distinguishes between interfaces that handle values in device-specific units (_raw) and event interfaces that handle values in real-world units (e.g. meters, Joules, lux, etc). However, the IIO event code infrastructure had never really implemented the bits to distinguish between those two types of interfaces and had always presumed events to handle raw device values.
For most current use cases, assuming events to handle values in device raw units is reasonable because it often matches the type of the associated IIO channel. There are a few cases where drivers provide events along side channels with both _raw and _input interfaces, though. Also, when real-world values can be mapped back to device configurations, it enables drivers to provide event interfaces that are arguably easier to use.
Expand the IIO events support, enabling IIO drivers to provide event interfaces that handle values in real-world units.
--- drivers/iio/industrialio-event.c | 47 +++++++++++++++++++++++--------- include/linux/iio/iio.h | 8 ++++-- include/uapi/linux/iio/types.h | 5 ++++ 3 files changed, 45 insertions(+), 15 deletions(-)
drivers/iio/industrialio-event.c +34 -13
@@ -258,6 +258,11 @@ static const char * const iio_ev_info_text[] = { [IIO_EV_INFO_RUNNING_COUNT] = "runningcount", }; +static const char *const iio_ev_unit_text[] = { + [IIO_EV_UNIT_RAW ] ="raw" , + [IIO_EV_UNIT_PROCESSED ] ="input" , +}; +static enum iio_event_direction iio_ev_attr_dir (struct iio_dev_attr *attr) {return attr->c->event_spec[attr->address &0xffff ].dir;
@@ -273,6 +278,11 @@ static enum iio_event_info iio_ev_attr_info(struct iio_dev_attr *attr)return (attr->address >>16 ) &0xffff ; } +static enum iio_event_unit iio_ev_attr_unit (struct iio_dev_attr *attr) +{ +return attr->c->event_spec[attr->address &0xffff ].unit; +} + static ssize_t iio_ev_state_store(struct device *dev, struct device_attribute *attr, const char *buf,
@@ -332,7 +342,7 @@ static ssize_t iio_ev_value_show(struct device *dev, ret = indio_dev->info->read_event_value (indio_dev, this_attr->c,iio_ev_attr_type (this_attr),iio_ev_attr_dir (this_attr),iio_ev_attr_info (this_attr), - &val, &val2); +iio_ev_attr_unit (this_attr), &val, &val2);if (ret <0 )return ret; val_arr[0 ] = val;
@@ -359,7 +369,7 @@ static ssize_t iio_ev_value_store(struct device *dev, ret = indio_dev->info->write_event_value (indio_dev, this_attr->c,iio_ev_attr_type (this_attr),iio_ev_attr_dir (this_attr),iio_ev_attr_info (this_attr), - val, val2); +iio_ev_attr_unit (this_attr), val, val2);if (ret <0 )return ret;
@@ -384,7 +394,8 @@ static ssize_t iio_ev_label_show(struct device *dev,static int iio_device_add_event (struct iio_dev *indio_dev,const struct iio_chan_spec *chan,unsigned int spec_index,enum iio_event_type type,enum iio_event_direction dir, -enum iio_shared_by shared_by,const unsigned long *mask) +enum iio_event_unit unit,enum iio_shared_by shared_by, +const unsigned long *mask) {struct iio_dev_opaque *iio_dev_opaque =to_iio_dev_opaque (indio_dev); ssize_t (*show)(struct device *dev, struct device_attribute *attr,
@@ -399,15 +410,23 @@ static int iio_device_add_event(struct iio_dev *indio_dev,for_each_set_bit (i, mask,sizeof (*mask)*8 ) {if (i >=ARRAY_SIZE (iio_ev_info_text))return -EINVAL ; -if (dir !=IIO_EV_DIR_NONE ) - postfix =kasprintf (GFP_KERNEL ,"%s_%s_%s" , - iio_ev_type_text[type], - iio_ev_dir_text[dir], - iio_ev_info_text[i]); -else +if (dir !=IIO_EV_DIR_NONE ) { +if (i ==IIO_EV_INFO_ENABLE ) + postfix =kasprintf (GFP_KERNEL ,"%s_%s_%s" , + iio_ev_type_text[type], + iio_ev_dir_text[dir], + iio_ev_info_text[i]); +else + postfix =kasprintf (GFP_KERNEL ,"%s_%s_%s_%s" , + iio_ev_unit_text[unit], + iio_ev_type_text[type], + iio_ev_dir_text[dir], + iio_ev_info_text[i]); + }else { postfix =kasprintf (GFP_KERNEL ,"%s_%s" , iio_ev_type_text[type], iio_ev_info_text[i]); + }if (postfix ==NULL )return -ENOMEM ;
@@ -478,32 +497,34 @@ static int iio_device_add_event_sysfs(struct iio_dev *indio_dev,int ret =0 , i, attrcount =0 ;enum iio_event_direction dir;enum iio_event_type type; +enum iio_event_unit unit;for (i =0 ; i < chan->num_event_specs; i++) { type = chan->event_spec[i].type; dir = chan->event_spec[i].dir; + unit = chan->event_spec[i].unit; - ret =iio_device_add_event (indio_dev, chan, i, type, dir, + ret =iio_device_add_event (indio_dev, chan, i, type, dir, unit,IIO_SEPARATE , &chan->event_spec[i].mask_separate);if (ret <0 )return ret; attrcount += ret; - ret =iio_device_add_event (indio_dev, chan, i, type, dir, + ret =iio_device_add_event (indio_dev, chan, i, type, dir, unit,IIO_SHARED_BY_TYPE , &chan->event_spec[i].mask_shared_by_type);if (ret <0 )return ret; attrcount += ret; - ret =iio_device_add_event (indio_dev, chan, i, type, dir, + ret =iio_device_add_event (indio_dev, chan, i, type, dir, unit,IIO_SHARED_BY_DIR , &chan->event_spec[i].mask_shared_by_dir);if (ret <0 )return ret; attrcount += ret; - ret =iio_device_add_event (indio_dev, chan, i, type, dir, + ret =iio_device_add_event (indio_dev, chan, i, type, dir, unit,IIO_SHARED_BY_ALL , &chan->event_spec[i].mask_shared_by_all);if (ret <0 )
include/linux/iio/iio.h +6 -2
@@ -156,6 +156,7 @@ typedef const struct iio_mount_matrix ** struct iio_event_spec - specification for a channel event * @type: Type of the event * @dir: Direction of the event +* @unit: Unit of the data to be handled (raw or processed). * @mask_separate: Bit mask of enum iio_event_info values. Attributes * set in this mask will be registered per channel. * @mask_shared_by_type: Bit mask of enum iio_event_info values. Attributes
@@ -169,6 +170,7 @@ typedef const struct iio_mount_matrix *struct iio_event_spec {enum iio_event_type type;enum iio_event_direction dir; +enum iio_event_unit unit;unsigned long mask_separate;unsigned long mask_shared_by_type;unsigned long mask_shared_by_dir;
@@ -522,13 +524,15 @@ struct iio_info {const struct iio_chan_spec *chan, enum iio_event_type type, enum iio_event_direction dir, - enum iio_event_info info, int *val, int *val2); + enum iio_event_info info, + enum iio_event_unit unit, int *val, int *val2);int (*write_event_value)(struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir, -enum iio_event_info info,int val,int val2); +enum iio_event_info info, +enum iio_event_unit unit,int val,int val2); int (*read_event_label)(struct iio_dev *indio_dev, struct iio_chan_spec const *chan,
include/uapi/linux/iio/types.h +5 -0
@@ -137,4 +137,9 @@ enum iio_event_direction { IIO_EV_DIR_FAULT_OPENWIRE, }; +enum iio_event_unit { +IIO_EV_UNIT_RAW , +IIO_EV_UNIT_PROCESSED , +}; +#endif /* _UAPI_IIO_TYPES_H_ */
Signature · 1 line
2.51.0
RFC PATCH 8/9 iio: dummy: iio_simple_dummy: Update to event unit expanded interface
In reply to Marcelo SchmittThe IIO events interface has been expanded with an additional parameter, enabling drivers to handle values in real-world units for IIO event configuration. Update to the expanded IIO event interface.
--- drivers/iio/dummy/iio_simple_dummy.h | 6 ++++-- drivers/iio/dummy/iio_simple_dummy_events.c | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-)
drivers/iio/dummy/iio_simple_dummy.h +4 -2
@@ -66,14 +66,16 @@ int iio_simple_dummy_read_event_value(struct iio_dev *indio_dev,const struct iio_chan_spec *chan, enum iio_event_type type, enum iio_event_direction dir, - enum iio_event_info info, int *val, + enum iio_event_info info, + enum iio_event_unit unit, int *val, int *val2);int iio_simple_dummy_write_event_value (struct iio_dev *indio_dev,const struct iio_chan_spec *chan,enum iio_event_type type,enum iio_event_direction dir, -enum iio_event_info info,int val, +enum iio_event_info info, +enum iio_event_unit unit,int val,int val2);int iio_simple_dummy_events_register (struct iio_dev *indio_dev);
drivers/iio/dummy/iio_simple_dummy_events.c +2 -0
@@ -120,6 +120,7 @@ int iio_simple_dummy_read_event_value(struct iio_dev *indio_dev,enum iio_event_type type, enum iio_event_direction dir, enum iio_event_info info, + enum iio_event_unit unit, int *val, int *val2) { struct iio_dummy_state *st = iio_priv(indio_dev);
@@ -144,6 +145,7 @@ int iio_simple_dummy_write_event_value(struct iio_dev *indio_dev,enum iio_event_type type, enum iio_event_direction dir, enum iio_event_info info, + enum iio_event_unit unit, int val, int val2) { struct iio_dummy_state *st = iio_priv(indio_dev);
Signature · 1 line
2.51.0
RFC PATCH 9/9 iio: adc: ad7091r-base: Update to event unit expanded interface
In reply to Marcelo SchmittThe IIO events interface has been expanded with an additional parameter, enabling drivers to handle values in real-world units for IIO event configuration. Update to the expanded IIO event interface.
--- drivers/iio/adc/ad7091r-base.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/iio/adc/ad7091r-base.c +5 -2
@@ -27,6 +27,7 @@ const struct iio_event_spec ad7091r_events[] = { { .type = IIO_EV_TYPE_THRESH, .dir = IIO_EV_DIR_FALLING, + .unit = IIO_EV_UNIT_RAW, .mask_separate =BIT (IIO_EV_INFO_VALUE ) | BIT(IIO_EV_INFO_ENABLE), },
@@ -183,7 +184,8 @@ static int ad7091r_read_event_value(struct iio_dev *indio_dev,const struct iio_chan_spec *chan, enum iio_event_type type, enum iio_event_direction dir, - enum iio_event_info info, int *val, int *val2) + enum iio_event_info info, + enum iio_event_unit unit, int *val, int *val2) { struct ad7091r_state *st = iio_priv(indio_dev);int ret;
@@ -224,7 +226,8 @@ static int ad7091r_write_event_value(struct iio_dev *indio_dev,const struct iio_chan_spec *chan, enum iio_event_type type, enum iio_event_direction dir, - enum iio_event_info info, int val, int val2) + enum iio_event_info info, + enum iio_event_unit unit, int val, int val2) { struct ad7091r_state *st = iio_priv(indio_dev);
Signature · 1 line
2.51.0
David Lechner
reviewerRe: [RFC PATCH v1 2/9] iio: ABI: Accurately describe in_distance_input
In reply to Marcelo SchmittQuoted 24 lines · Marcelo Schmitt
There is only one driver (
drivers/iio/accel/mma9553.c) that declares a channel of typeIIO_DISTANCEwith aninfo_maskcontainingIIO_CHAN_INFO_PROCESSED. Though,mma9553.cprovides distance in meters (as would be expected for the_inputinterface). Splitin_distance_rawandin_distance_inputABI documentation to provide accurate description for thein_distance_inputinterface.Fixes 7cf78db585b1 ("iio: Add ABI documentation for illuminance raw and scale values in light")Signed-off-by Marcelo Schmitt <[email protected]>---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++ 1 file changed, 7 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -1613,6 +1613,13 @@ Description: user). Units after application of scale are Joules. What: /sys/.../iio:deviceX/in_distance_input
Documentation/ABI/testing/sysfs-bus-iio Description: · line 1625
Quoted 10 lines
Documentation/ABI/testing/sysfs-bus-iio +7
-0+KernelVersion: 4.0 +Contact: [email protected] +Description: + This attribute is used to read the measured distance (in meters) + to an object or the distance covered by the user since the last + reboot while activated. + What: /sys/.../iio:deviceX/in_distance_raw KernelVersion: 4.0 Contact: [email protected]
I'm not sure it is worth splitting these up since the documentation is just repeated except for the bit about scale. And it is common knowledge that scale only applies to raw and not input.
Also, looks like raw and input are swapped. raw it the one with scale so the sentence about scale should be with the raw attribute.
David Lechner
reviewerQuoted 17 lines · Marcelo Schmitt
The IIO event ABI documentation distinguishes between interfaces that handle values in device-specific units (
_raw) and event interfaces that handle values in real-world units (e.g. meters, Joules, lux, etc). However, the IIO event code infrastructure had never really implemented the bits to distinguish between those two types of interfaces and had always presumed events to handle raw device values.For most current use cases, assuming events to handle values in device raw units is reasonable because it often matches the type of the associated IIO channel. There are a few cases where drivers provide events along side channels with both
_rawand_inputinterfaces, though. Also, when real-world values can be mapped back to device configurations, it enables drivers to provide event interfaces that are arguably easier to use.Expand the IIO events support, enabling IIO drivers to provide event interfaces that handle values in real-world units.
...
Quoted 13 lines
drivers/iio/industrialio-event.c +3
-6@@ -399,15 +410,23 @@ static int iio_device_add_event(struct iio_dev *indio_dev,for_each_set_bit (i, mask,sizeof (*mask)*8 ) {if (i >=ARRAY_SIZE (iio_ev_info_text))return -EINVAL ; -if (dir !=IIO_EV_DIR_NONE ) - postfix =kasprintf (GFP_KERNEL ,"%s_%s_%s" , - iio_ev_type_text[type], - iio_ev_dir_text[dir], - iio_ev_info_text[i]); -else +if (dir !=IIO_EV_DIR_NONE ) { +if (i ==IIO_EV_INFO_ENABLE ) + postfix = kasprintf(GFP_KERNEL, "%s_%s_%s",
drivers/iio/industrialio-event.c static int iio_device_add_event(struct iio_dev *indio_dev, · line 425
Quoted 10 lines
drivers/iio/industrialio-event.c +10
-0+ iio_ev_type_text[type], + iio_ev_dir_text[dir], + iio_ev_info_text[i]); + else + postfix =kasprintf (GFP_KERNEL ,"%s_%s_%s_%s" , + iio_ev_unit_text[unit], + iio_ev_type_text[type], + iio_ev_dir_text[dir], + iio_ev_info_text[i]); + }else {
I think that the units only make sense on IIO_EV_INFO_VALUE and IIO_EV_INFO_HYSTERESIS. Everything else has it's own unit, not just IIO_EV_INFO_ENABLE.
Quoted 7 lines
drivers/iio/industrialio-event.c +1
-0postfix =kasprintf (GFP_KERNEL ,"%s_%s" , iio_ev_type_text[type], iio_ev_info_text[i]); + }if (postfix ==NULL )return -ENOMEM ;
David Lechner
reviewerQuoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes.
I generally like the idea. There were a number of times recently when adding events where we had to do complex calculation to convert to/from raw units for the event value because it needed to match the in_..._raw scaling. In these cases it would have been much more convenient to be able to use SI units for the event value while keeping raw+scale for the actual sensor value.
Quoted 49 lines
I'm actually proposing this set just for the sake of solving the event ABI naming inconsistency. I recall the event ABI was a bit puzzling to understand when I was having a closer look at that a while ago [1].
[1]: https://lore.kernel.org/linux-iio/[email protected]/Also, I'm doing this set entirely on my spare time and just because I wanted to have the ABI naming inconsistency fixed. This is also a late reply to [2]. [2]: https://lore.kernel.org/linux-iio/20251109164312.781de64c@jic23-huawei/
I've tested this with ad7091r8 driver and result is:
Before event extension (current IIO teting branch):
root@localhost:~# ls /sys/bus/iio/devices/iio:device0/events in_voltage0_thresh_either_hysteresis in_voltage4_thresh_either_hysteresis in_voltage0_thresh_falling_en in_voltage4_thresh_falling_en in_voltage0_thresh_falling_value in_voltage4_thresh_falling_value in_voltage0_thresh_rising_en in_voltage4_thresh_rising_en in_voltage0_thresh_rising_value in_voltage4_thresh_rising_value in_voltage1_thresh_either_hysteresis in_voltage5_thresh_either_hysteresis in_voltage1_thresh_falling_en in_voltage5_thresh_falling_en in_voltage1_thresh_falling_value in_voltage5_thresh_falling_value in_voltage1_thresh_rising_en in_voltage5_thresh_rising_en in_voltage1_thresh_rising_value in_voltage5_thresh_rising_value in_voltage2_thresh_either_hysteresis in_voltage6_thresh_either_hysteresis in_voltage2_thresh_falling_en in_voltage6_thresh_falling_en in_voltage2_thresh_falling_value in_voltage6_thresh_falling_value in_voltage2_thresh_rising_en in_voltage6_thresh_rising_en in_voltage2_thresh_rising_value in_voltage6_thresh_rising_value in_voltage3_thresh_either_hysteresis in_voltage7_thresh_either_hysteresis in_voltage3_thresh_falling_en in_voltage7_thresh_falling_en in_voltage3_thresh_falling_value in_voltage7_thresh_falling_value in_voltage3_thresh_rising_en in_voltage7_thresh_rising_en in_voltage3_thresh_rising_value in_voltage7_thresh_rising_valueAfter event extension:
root@localhost:~# ls /sys/bus/iio/devices/iio:device0/events in_voltage0_raw_thresh_either_hysteresis in_voltage4_raw_thresh_either_hysteresis in_voltage0_raw_thresh_falling_value in_voltage4_raw_thresh_falling_value in_voltage0_raw_thresh_rising_value in_voltage4_raw_thresh_rising_value in_voltage0_thresh_falling_en in_voltage4_thresh_falling_en in_voltage0_thresh_rising_en in_voltage4_thresh_rising_en in_voltage1_raw_thresh_either_hysteresis in_voltage5_raw_thresh_either_hysteresis in_voltage1_raw_thresh_falling_value in_voltage5_raw_thresh_falling_value in_voltage1_raw_thresh_rising_value in_voltage5_raw_thresh_rising_value in_voltage1_thresh_falling_en in_voltage5_thresh_falling_en in_voltage1_thresh_rising_en in_voltage5_thresh_rising_en in_voltage2_raw_thresh_either_hysteresis in_voltage6_raw_thresh_either_hysteresis in_voltage2_raw_thresh_falling_value in_voltage6_raw_thresh_falling_value
Quoted 8 lines
in_voltage2_raw_thresh_rising_value in_voltage6_raw_thresh_rising_value in_voltage2_thresh_falling_en in_voltage6_thresh_falling_en in_voltage2_thresh_rising_en in_voltage6_thresh_rising_en in_voltage3_raw_thresh_either_hysteresis in_voltage7_raw_thresh_either_hysteresis in_voltage3_raw_thresh_falling_value in_voltage7_raw_thresh_falling_value in_voltage3_raw_thresh_rising_value in_voltage7_raw_thresh_rising_value in_voltage3_thresh_falling_en in_voltage7_thresh_falling_en in_voltage3_thresh_rising_en in_voltage7_thresh_rising_en
We can't be breaking ABI like this. There are some alternatives though. We could register duplicate attributes with both the old and the new name (or can we make the old name a symlink to the new?). Or we could add a 3rd option to the unit of IIO_EV_UNIT_NONE and use that on existing drivers so that they don't change the attribute name.
Quoted 29 lines
The difference is the '
_raw' element inthresh_(rising|falling|either)attributes.Why posting it as an RFC?
1) ABI changes a sensitive topic.
2) There are 77 drivers that will go through collateral evolution with the event interface update. A 77+ patch set is probably not a good idea? I recall theclaim_directstuff was split into 2 or more patch sets. This might need a similar approach (if accepted).
3) My coccinelle semantic patch does a nice job in updating the vast majority of the drivers but, it produces diffs longer than needed. E.g.(quoted diff) +2
-1@@ -844,7 +844,8 @@ static int adxl313_read_event_value(stru enum iio_event_type type, enum iio_event_direction dir, enum iio_event_info info, - int *val, int *val2) + enum iio_event_unit unit, int *val, + int *val2)could be
(quoted diff) +1
-0@@ -844,6 +844,7 @@ static int adxl313_read_event_value(struct iio_dev *indio_dev, enum iio_event_type type, enum iio_event_direction dir, enum iio_event_info info, + enum iio_event_unit unit, int *val, int *val2)
Quoted 3 lines
I'll try to figure out how to make it generate smaller diffs, or do the changes by hand if needed.
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum iio_event_info to add IIO_EV_INFO_VALUE_RAW and IIO_EV_INFO_VALUE_INPUT (and same for HYSTERESIS). Really, the units only make sense for these two info types anyway.
This would work like my suggestion above that existing drivers would continue to use the old enum value, but we would encourage using the new enum values in new code. And it would eliminate the churn of having to touch every existing user.
And if someone really wants to take advantage of the new naming for a driver with existing events, we could do the duplicate attribute thing I mentioned above still.
kernel test robot
build botkernel test robot noticed the following build errors:
Hi Marcelo,
[This is a private test report for your RFC patch.] kernel test robot noticed the following build errors:
[auto build test ERROR on c30e80d68a7afb334fde7147ee0106f25dd58d3a]
url: https://github.com/intel-lab-lkp/linux/commits/Marcelo-Schmitt/iio-ABI-Drop-unused-in_energy_input/20260119-022321 base: c30e80d68a7afb334fde7147ee0106f25dd58d3a patch link: https://lore.kernel.org/r/6d9baa8d553d03a41fbd97bca0377a7a4779a93e.1768759292.git.marcelo.schmitt1%40gmail.com patch subject: [RFC PATCH v1 7/9] iio: Expand IIO event interface for real-world unit handling config: i386-buildonly-randconfig-003-20260119 (https://download.01.org/0day-ci/archive/20260119/[email protected]/config) compiler: gcc-14 (Debian 14.2.0-19) 14.2.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20260119/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
>> drivers/iio/temperature/tmp007.c:422:29: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int *, int *)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int *, int *)' [-Wincompatible-pointer-types]
422 | .read_event_value = tmp007_read_thresh,
| ^~~~~~~~~~~~~~~~~~
drivers/iio/temperature/tmp007.c:422:29: note: (near initialization for 'tmp007_info.read_event_value')
>> drivers/iio/temperature/tmp007.c:423:30: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int, int)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int, int)' [-Wincompatible-pointer-types]
423 | .write_event_value = tmp007_write_thresh,
| ^~~~~~~~~~~~~~~~~~~
drivers/iio/temperature/tmp007.c:423:30: note: (near initialization for 'tmp007_info.write_event_value')
--
>> drivers/iio/accel/bmc150-accel-core.c:1160:35: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int *, int *)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int *, int *)' [-Wincompatible-pointer-types] 1160 | .read_event_value = bmc150_accel_read_event,
| ^~~~~~~~~~~~~~~~~~~~~~~
drivers/iio/accel/bmc150-accel-core.c:1160:35: note: (near initialization for 'bmc150_accel_info.read_event_value')
drivers/iio/accel/bmc150-accel-core.c:1161:35: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int, int)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int, int)' [-Wincompatible-pointer-types]
1161 | .write_event_value = bmc150_accel_write_event,
| ^~~~~~~~~~~~~~~~~~~~~~~~
drivers/iio/accel/bmc150-accel-core.c:1161:35: note: (near initialization for 'bmc150_accel_info.write_event_value')
drivers/iio/accel/bmc150-accel-core.c:1170:35: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int *, int *)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int *, int *)' [-Wincompatible-pointer-types]
1170 | .read_event_value = bmc150_accel_read_event,
| ^~~~~~~~~~~~~~~~~~~~~~~
drivers/iio/accel/bmc150-accel-core.c:1170:35: note: (near initialization for 'bmc150_accel_info_fifo.read_event_value')
drivers/iio/accel/bmc150-accel-core.c:1171:35: error: initialization of 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int, int)' from incompatible pointer type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int, int)' [-Wincompatible-pointer-types]
1171 | .write_event_value = bmc150_accel_write_event,
| ^~~~~~~~~~~~~~~~~~~~~~~~
drivers/iio/accel/bmc150-accel-core.c:1171:35: note: (near initialization for 'bmc150_accel_info_fifo.write_event_value')
Kconfig warnings: (for reference only)
WARNING: unmet direct dependencies detected for CAN_DEV Depends on [n]: NETDEVICES [=n] && CAN [=y] Selected by [y]:
- CAN [=y] && NET [=y]
vim +422 drivers/iio/temperature/tmp007.c
948b707df8d249 Manivannan Sadhasivam 2017-01-09 416
948b707df8d249 Manivannan Sadhasivam 2017-01-09 417 static const struct iio_info tmp007_info = {
948b707df8d249 Manivannan Sadhasivam 2017-01-09 418 .read_raw = tmp007_read_raw,
948b707df8d249 Manivannan Sadhasivam 2017-01-09 419 .write_raw = tmp007_write_raw,
7c5bc7e87cc43a Manivannan Sadhasivam 2017-01-23 420 .read_event_config = tmp007_read_event_config,
7c5bc7e87cc43a Manivannan Sadhasivam 2017-01-23 421 .write_event_config = tmp007_write_event_config,
7c5bc7e87cc43a Manivannan Sadhasivam 2017-01-23 @422 .read_event_value = tmp007_read_thresh,
7c5bc7e87cc43a Manivannan Sadhasivam 2017-01-23 @423 .write_event_value = tmp007_write_thresh,
948b707df8d249 Manivannan Sadhasivam 2017-01-09 424 .attrs = &tmp007_attribute_group,
948b707df8d249 Manivannan Sadhasivam 2017-01-09 425 };948b707df8d249 Manivannan Sadhasivam 2017-01-09 426
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
kernel test robot
build botkernel test robot noticed the following build errors:
Hi Marcelo,
[This is a private test report for your RFC patch.] kernel test robot noticed the following build errors:
[auto build test ERROR on c30e80d68a7afb334fde7147ee0106f25dd58d3a]
url: https://github.com/intel-lab-lkp/linux/commits/Marcelo-Schmitt/iio-ABI-Drop-unused-in_energy_input/20260119-022321 base: c30e80d68a7afb334fde7147ee0106f25dd58d3a patch link: https://lore.kernel.org/r/6d9baa8d553d03a41fbd97bca0377a7a4779a93e.1768759292.git.marcelo.schmitt1%40gmail.com patch subject: [RFC PATCH v1 7/9] iio: Expand IIO event interface for real-world unit handling config: i386-buildonly-randconfig-005-20260119 (https://download.01.org/0day-ci/archive/20260119/[email protected]/config) compiler: clang version 20.1.8 (https://github.com/llvm/llvm-project 87f0227cb60147a26a1eeb4fb06e3b505e9c7261) reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20260119/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>):
>> drivers/iio/dac/ad8460.c:653:23: error: incompatible function pointer types initializing 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int, int)' with an expression of type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int, int)' [-Wincompatible-function-pointer-types]
653 | .write_event_value = &ad8460_write_event_value,
| ^~~~~~~~~~~~~~~~~~~~~~~~~
drivers/iio/dac/ad8460.c:654:22: error: incompatible function pointer types initializing 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, enum iio_event_unit, int *, int *)' with an expression of type 'int (*)(struct iio_dev *, const struct iio_chan_spec *, enum iio_event_type, enum iio_event_direction, enum iio_event_info, int *, int *)' [-Wincompatible-function-pointer-types]
654 | .read_event_value = &ad8460_read_event_value,
| ^~~~~~~~~~~~~~~~~~~~~~~~2 errors generated.
Kconfig warnings: (for reference only)
WARNING: unmet direct dependencies detected for CAN_DEV Depends on [n]: NETDEVICES [=n] && CAN [=y] Selected by [y]:
- CAN [=y] && NET [=y]
vim +653 drivers/iio/dac/ad8460.c
a976ef24c62540d Mariel Tinaco 2024-09-12 649
a976ef24c62540d Mariel Tinaco 2024-09-12 650 static const struct iio_info ad8460_info = {
a976ef24c62540d Mariel Tinaco 2024-09-12 651 .read_raw = &ad8460_read_raw,
a976ef24c62540d Mariel Tinaco 2024-09-12 652 .write_raw = &ad8460_write_raw,
a976ef24c62540d Mariel Tinaco 2024-09-12 @653 .write_event_value = &ad8460_write_event_value,
a976ef24c62540d Mariel Tinaco 2024-09-12 654 .read_event_value = &ad8460_read_event_value,
a976ef24c62540d Mariel Tinaco 2024-09-12 655 .write_event_config = &ad8460_write_event_config,
a976ef24c62540d Mariel Tinaco 2024-09-12 656 .read_event_config = &ad8460_read_event_config,
a976ef24c62540d Mariel Tinaco 2024-09-12 657 .debugfs_reg_access = &ad8460_reg_access,
a976ef24c62540d Mariel Tinaco 2024-09-12 658 };a976ef24c62540d Mariel Tinaco 2024-09-12 659
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
kernel test robot
build botRe: [RFC PATCH v1 8/9] iio: dummy: iio_simple_dummy: Update to event unit expanded interface
In reply to Marcelo Schmittkernel test robot noticed the following build warnings:
Hi Marcelo,
[This is a private test report for your RFC patch.] kernel test robot noticed the following build warnings:
[auto build test WARNING on c30e80d68a7afb334fde7147ee0106f25dd58d3a]
url: https://github.com/intel-lab-lkp/linux/commits/Marcelo-Schmitt/iio-ABI-Drop-unused-in_energy_input/20260119-022321 base: c30e80d68a7afb334fde7147ee0106f25dd58d3a patch link: https://lore.kernel.org/r/40da257176192dce3b271c45b6ce7dcaa15b06af.1768759292.git.marcelo.schmitt1%40gmail.com patch subject: [RFC PATCH v1 8/9] iio: dummy: iio_simple_dummy: Update to event unit expanded interface config: s390-randconfig-001-20260119 (https://download.01.org/0day-ci/archive/20260119/[email protected]/config) compiler: s390-linux-gcc (GCC) 9.5.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20260119/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
>> Warning: drivers/iio/dummy/iio_simple_dummy_events.c:124 function parameter 'unit' not described in 'iio_simple_dummy_read_event_value' >> Warning: drivers/iio/dummy/iio_simple_dummy_events.c:149 function parameter 'unit' not described in 'iio_simple_dummy_write_event_value' >> Warning: drivers/iio/dummy/iio_simple_dummy_events.c:124 function parameter 'unit' not described in 'iio_simple_dummy_read_event_value' >> Warning: drivers/iio/dummy/iio_simple_dummy_events.c:149 function parameter 'unit' not described in 'iio_simple_dummy_write_event_value'
Kconfig warnings: (for reference only)
WARNING: unmet direct dependencies detected for REGMAP_I3C Depends on [n]: I3C [=n]
Selected by [y]:
- MMC5633 [=y] && IIO [=y] && (I2C [=y] || I3C [=n])
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
Quoted 7 lines · David Lechner
Quoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes.
...
Quoted 6 lines
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum
iio_event_infoto addIIO_EV_INFO_VALUE_RAWandIIO_EV_INFO_VALUE_INPUT(and same for HYSTERESIS).
Makes sense. If no other idea comes up, I'll go with that for the next version.
Quoted 2 lines
Really, the units only make sense for these
two info types anyway.
Ah good point. I was too hasty in thinking the _raw/_input distinction would apply to other event_info options. Will avoid affecting those.
Thanks
Quoted 9 lines
This would work like my suggestion above that existing drivers would continue to use the old enum value, but we would encourage using the new enum values in new code. And it would eliminate the churn of having to touch every existing user.
And if someone really wants to take advantage of the new naming for a driver with existing events, we could do the duplicate attribute thing I mentioned above still.
Re: [RFC PATCH v1 2/9] iio: ABI: Accurately describe in_distance_input
In reply to David LechnerQuoted 24 lines · David Lechner
Quoted 23 lines · Marcelo Schmitt
There is only one driver (
drivers/iio/accel/mma9553.c) that declares a channel of typeIIO_DISTANCEwith aninfo_maskcontainingIIO_CHAN_INFO_PROCESSED. Though,mma9553.cprovides distance in meters (as would be expected for the_inputinterface). Splitin_distance_rawandin_distance_inputABI documentation to provide accurate description for thein_distance_inputinterface.Fixes 7cf78db585b1 ("iio: Add ABI documentation for illuminance raw and scale values in light")Signed-off-by Marcelo Schmitt <[email protected]>---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++ 1 file changed, 7 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -1613,6 +1613,13 @@ Description: user). Units after application of scale are Joules.
Quoted 15 lines
Documentation/ABI/testing/sysfs-bus-iio Description: · line 1625
Quoted 11 lines
Documentation/ABI/testing/sysfs-bus-iio +7
-0What: /sys/.../iio:deviceX/in_distance_input +KernelVersion: 4.0 +Contact: [email protected] +Description: + This attribute is used to read the measured distance (in meters) + to an object or the distance covered by the user since the last + reboot while activated. + What: /sys/.../iio:deviceX/in_distance_raw KernelVersion: 4.0 Contact: [email protected]I'm not sure it is worth splitting these up since the documentation is just repeated except for the bit about scale. And it is common knowledge that scale only applies to raw and not input.
It's common knowledge to us who are familiar with IIO. For anyone else, it might not be. Plus, it is tecnically incorrect to have _raw and _input together like they were before.
Quoted 3 lines
Also, looks like raw and input are swapped. raw it the one with scale so the sentence about scale should be with the raw attribute.
Hmm, have I messed up with the patches? Their final look in my local tree is:
What: /sys/.../iio:deviceX/in_distance_input
KernelVersion: 4.0
Contact: [email protected]
Description:
This attribute is used to read the measured distance (in meters) to an object or the distance covered by the user since the last reboot while activated.
What: /sys/.../iio:deviceX/in_distance_raw
KernelVersion: 4.0
Contact: [email protected]
Description:
This attribute is used to read the measured distance to an object or the distance covered by the user since the last reboot while activated. Units after application of scale are meters.
Quoted 7 lines · David Lechner
Quoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes.
...
Quoted 8 lines
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum
iio_event_infoto addIIO_EV_INFO_VALUE_RAWandIIO_EV_INFO_VALUE_INPUT(and same for HYSTERESIS). Really, the units only make sense for these two info types anyway.
Makes sense to me. Or we can just document that the old value is _INPUT? Or just make it the same value in the enum.
- Nuno Sá
David Lechner
reviewerQuoted 20 lines · Nuno Sá
Quoted 7 lines · David Lechner
Quoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes....
Quoted 8 lines
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum
iio_event_infoto addIIO_EV_INFO_VALUE_RAWandIIO_EV_INFO_VALUE_INPUT(and same for HYSTERESIS). Really, the units only make sense for these two info types anyway.
Quoted 4 lines
Makes sense to me. Or we can just document that the old value is
_INPUT? Or just make it the same value in the enum.- Nuno Sá
I don't think that works since IIO_EV_INFO_VALUE could be _RAW or _INPUT depending on the driver. And another point was that this should also control the _raw or _input in the attribute name, and we can't change the existing attribute names.
Jonathan Cameron
maintainerQuoted 24 lines · On Wed, 21 Jan 2026 11:43:03 -0600 David Lechner <[email protected]> wrote:
Quoted 23 lines · Nuno Sá
Quoted 7 lines · David Lechner
Quoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes....
Quoted 8 lines
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum
iio_event_infoto addIIO_EV_INFO_VALUE_RAWandIIO_EV_INFO_VALUE_INPUT(and same for HYSTERESIS). Really, the units only make sense for these two info types anyway.Makes sense to me. Or we can just document that the old value is
_INPUT? Or just make it the same value in the enum.
Quoted 7 lines
Quoted 1 line
- Nuno Sá
I don't think that works since
IIO_EV_INFO_VALUEcould be_RAWor_INPUTdepending on the driver. And another point was that this should also control the_rawor_inputin the attribute name, and we can't change the existing attribute names.
Fully agree with David here. To fix this up we need new ABI, with the old ABI remaining in place (including for new drivers) where the raw or processed nature of event values is derived from whether they have _raw or _input (and hopefully not the horrible case of both!)
The new drivers keeping this bit is the only place I might be flexible if it is a real problem. I'd still strongly prefer devices to match the channel presentation for these but if there is a really tricky corner case for a particular part then 'maybe' we can relax it. Upshot is that it won't work with standard userspace code that is old.
Not the first time we've had to add new ABI and keep the old (whilst telling people not to use it)
The multiple buffers stuff is a good example.
Jonathan
Jonathan Cameron
maintainerRe: [RFC PATCH v1 1/9] iio: ABI: Drop unused in_energy_input
In reply to Marcelo SchmittQuoted 5 lines · On Sun, 18 Jan 2026 15:18:57 -0300 Marcelo Schmitt…
No IIO driver declares a channel of type
IIO_ENERGYwithinfo_maskcontainingIIO_CHAN_INFO_PROCESSED. Thus,in_energy_inputhas never been seen in user space.Fixes 72c66644673a ("iio: core: Introduce ENERGY channel type")
I don't think the fixes tag makes sense. This is just tidy up of unused ABI, because why document what doesn't exist?
Quoted 20 lines
Signed-off-by Marcelo Schmitt <[email protected]>---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?Documentation/ABI/testing/sysfs-bus-iio | 1 - 1 file changed, 1 deletion(-)Documentation/ABI/testing/sysfs-bus-iio +0
-1@@ -1601,7 +1601,6 @@ Description: For a list of available output power modes read in_accel_power_mode_available. -What: /sys/.../iio:deviceX/in_energy_input What: /sys/.../iio:deviceX/in_energy_raw What: /sys/.../iio:deviceX/in_energyY_active_raw What: /sys/.../iio:deviceX/in_energyY_reactive_raw
Jonathan Cameron
maintainerRe: [RFC PATCH v1 2/9] iio: ABI: Accurately describe in_distance_input
In reply to Marcelo SchmittQuoted 41 lines · On Tue, 20 Jan 2026 23:49:11 -0300 Marcelo Schmitt…
Quoted 24 lines · David Lechner
Quoted 23 lines · Marcelo Schmitt
There is only one driver (
drivers/iio/accel/mma9553.c) that declares a channel of typeIIO_DISTANCEwith aninfo_maskcontainingIIO_CHAN_INFO_PROCESSED. Though,mma9553.cprovides distance in meters (as would be expected for the_inputinterface). Splitin_distance_rawandin_distance_inputABI documentation to provide accurate description for thein_distance_inputinterface.Fixes 7cf78db585b1 ("iio: Add ABI documentation for illuminance raw and scale values in light")Signed-off-by Marcelo Schmitt <[email protected]>---
Added a fix tag though not sure it's needed/desired since it might not be worth to backport documentation?Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++ 1 file changed, 7 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -1613,6 +1613,13 @@ Description: user). Units after application of scale are Joules.Quoted 15 lines
Documentation/ABI/testing/sysfs-bus-iio Description: · line 1625
Quoted 11 lines
Documentation/ABI/testing/sysfs-bus-iio +7
-0What: /sys/.../iio:deviceX/in_distance_input +KernelVersion: 4.0 +Contact: [email protected] +Description: + This attribute is used to read the measured distance (in meters) + to an object or the distance covered by the user since the last + reboot while activated. + What: /sys/.../iio:deviceX/in_distance_raw KernelVersion: 4.0 Contact: [email protected]I'm not sure it is worth splitting these up since the documentation is just repeated except for the bit about scale. And it is common knowledge that scale only applies to raw and not input.
Quoted 3 lines
It's common knowledge to us who are familiar with IIO. For anyone else, it might not be. Plus, it is tecnically incorrect to have
_rawand_inputtogether like they were before.
If it's caused confusion. I think it's worth splitting them. If the repeated text becomes too large, we can use a cross reference.
J
Quoted 22 lines
Quoted 4 lines
Also, looks like raw and input are swapped. raw it the one with scale so the sentence about scale should be with the raw attribute.
Hmm, have I messed up with the patches? Their final look in my local tree is:
What: /sys/.../iio:deviceX/in_distance_input
KernelVersion: 4.0
Contact: [email protected]
Description:
This attribute is used to read the measured distance (in meters) to an object or the distance covered by the user since the last reboot while activated.What: /sys/.../iio:deviceX/in_distance_raw
KernelVersion: 4.0
Contact: [email protected]
Description:
This attribute is used to read the measured distance to an object or the distance covered by the user since the last reboot while activated. Units after application of scale are meters.
Jonathan Cameron
maintainerQuoted 11 lines · On Sun, 18 Jan 2026 15:21:46 -0300 Marcelo Schmitt…
The IIO event ABI documentation distinguishes between interfaces that handle values in device-specific units (
_raw) and event interfaces that handle values in real-world units (e.g. meters, Joules, lux, etc). However, the IIO event code infrastructure had never really implemented the bits to distinguish between those two types of interfaces and had always presumed events to handle raw device values.For most current use cases, assuming events to handle values in device raw units is reasonable because it often matches the type of the associated IIO channel. There are a few cases where drivers provide events along side channels with both
_rawand_inputinterfaces, though. Also, when
Can you list those cases. I thought we'd been keeping an eye out for that but seems they slipped through!
Quoted 7 lines
real-world values can be mapped back to device configurations, it enables drivers to provide event interfaces that are arguably easier to use.
Expand the IIO events support, enabling IIO drivers to provide event interfaces that handle values in real-world units.
Signed-off-by Marcelo Schmitt <[email protected]>
Quoted 46 lines · Jonathan Cameron
Quoted 24 lines · On Wed, 21 Jan 2026 11:43:03 -0600 David Lechner <[email protected]> wrote:
Quoted 23 lines · Nuno Sá
Quoted 7 lines · David Lechner
Quoted 5 lines · Marcelo Schmitt
This patch set adjusts and complements the IIO event ABI docs making them coherent with the fact that not all threshold value attributes had a _raw/_input indicator set in their names. In addition that, the latter patches on this series update the IIO event infrastructure to actually enable drivers to provide
_inputthreshold value attributes....
Quoted 8 lines
Just throwing out an idea here without thinking about it too much...
Instead of adding a new field/parameter for units, could we extend enum
iio_event_infoto addIIO_EV_INFO_VALUE_RAWandIIO_EV_INFO_VALUE_INPUT(and same for HYSTERESIS). Really, the units only make sense for these two info types anyway.Makes sense to me. Or we can just document that the old value is
_INPUT? Or just make it the same value in the enum.Quoted 7 lines
Quoted 1 line
- Nuno Sá
I don't think that works since
IIO_EV_INFO_VALUEcould be_RAWor_INPUTdepending on the driver. And another point was that this should also control the_rawor_inputin the attribute name, and we can't change the existing attribute names.Fully agree with David here. To fix this up we need new ABI, with the old ABI remaining in place (including for new drivers) where the raw or processed nature of event values is derived from whether they have
_rawor_input(and hopefully not the horrible case of both!)The new drivers keeping this bit is the only place I might be flexible if it is a real problem. I'd still strongly prefer devices to match the channel presentation for these but if there is a really tricky corner case for a particular part then 'maybe' we can relax it. Upshot is that it won't work with standard userspace code that is old.
Quoted 3 lines
Not the first time we've had to add new ABI and keep the old (whilst telling people not to use it)
The multiple buffers stuff is a good example.
Sure, I was not suggesting to destroy ABI. Just a suggestion for the enum :)
Yeah, I desperately need to find a proper multibuffer user for upstream. We do have some issues there...
- Nuno Sá