mbox series

[v4,0/5] iio: vcnl4000: Export near level property for proximity sensor

Message ID cover.1586094535.git.agx@sigxcpu.org
Headers show
Series iio: vcnl4000: Export near level property for proximity sensor | expand

Message

Guido Günther April 5, 2020, 1:50 p.m. UTC
If an object can be considered close to the device that has the proximity
sensor built in is hardware dependent. Allowing to configure the property via
device tree allows to export this device specific value to userspace via
ext_info. This is useful for e.g. iio-sensor-proxy.

This came up when adding proximity support to iio-sensor-proxy [1], [2], it is
not meant as a vcnl4000 thing but rather as something useful for other proximity
sensors too in the future.

I've not converted the vcnl4000 binding docs to yaml but can do so as part of
this series in a v2 if the approach makes sense.

Changes from v3:
- as per review comment by Jonathan Cameron
  Fix patch title and description of sysfs patch
  https://lore.kernel.org/linux-iio/20200329102705.0a69000c@archlinux/
- Add Reviewed-by by Rob Herring, thanks!
  https://lore.kernel.org/linux-iio/20200331214330.GA24010@bogus/
- As per review comments by Rob Herring
  https://lore.kernel.org/linux-iio/20200331214517.GA24128@bogus/
  - Rename property to proximity-near-level
  - document proximity-near-level in a common file

Changes from v2:
- as per review comment by Lars-Peter Clausen
  https://lore.kernel.org/linux-iio/c787921f-c412-4986-14ea-e31b531d3d5b@metafoo.de/
  Switch sysfs name to `nearlevel`
- as per review comment by Nishant Malpani
  https://lore.kernel.org/linux-iio/f5ea512c-d427-94c7-cf5f-f1300cbd4aa3@gmail.com/
  Add manufacturer do binding document name
- as per review comments by Andy Shevchenko
  - Drop superfluous blank line
  - Check return value of device_property_read_u32 for '!= 0' instead of '< 0'

Changes from v1:
- as per review comments by Jonathan Cameron
  https://lore.kernel.org/linux-iio/20200221120519.43b72007@archlinux/
  Document new sysfs file in Documentation/ABI/testing/sysfs-bus-iio-proximity
- convert bindings to yaml
- bindings: fix typo in near-level property

[1]: https://gitlab.freedesktop.org/hadess/iio-sensor-proxy/merge_requests/298
[2]: https://lore.kernel.org/linux-iio/20200210154153.GA26903@bogon.m.sigxcpu.org/

To: Tomas Novotny <tomas@novotny.cz>, Jonathan Cameron <jic23@kernel.org>,Hartmut Knaack <knaack.h@gmx.de>,Lars-Peter Clausen <lars@metafoo.de>,Peter Meerwald-Stadler <pmeerw@pmeerw.net>,"Angus Ainslie (Purism)" <angus@akkea.ca>,"Guido Günther" <agx@sigxcpu.org>,Marco Felsch <m.felsch@pengutronix.de>,Thomas Gleixner <tglx@linutronix.de>,linux-iio@vger.kernel.org,linux-kernel@vger.kernel.org,devicetree@vger.kernel.org,Andy Shevchenko <andy.shevchenko@gmail.com>,Nishant Malpani <nish.malpani25@gmail.com>


Guido Günther (5):
  dt-bindings: iio: vcnl4000: convert bindings to YAML format
  dt-bindings: iio: Introduce common properties for iio sensors
  dt-bindings: iio: light: vcnl4000: Add proximity-near-level
  iio: vcnl4000: Export near level property for proximity sensor
  Documentation: ABI: document IIO in_proximity_nearlevel file

 .../ABI/testing/sysfs-bus-iio-proximity       | 10 ++++
 .../devicetree/bindings/iio/common.yaml       | 35 +++++++++++++
 .../bindings/iio/light/vcnl4000.txt           | 24 ---------
 .../bindings/iio/light/vishay,vcnl4000.yaml   | 50 +++++++++++++++++++
 drivers/iio/light/vcnl4000.c                  | 25 ++++++++++
 5 files changed, 120 insertions(+), 24 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-proximity
 create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
 delete mode 100644 Documentation/devicetree/bindings/iio/light/vcnl4000.txt
 create mode 100644 Documentation/devicetree/bindings/iio/light/vishay,vcnl4000.yaml

Comments

Jonathan Cameron April 18, 2020, 6:05 p.m. UTC | #1
On Sun,  5 Apr 2020 15:50:31 +0200
Guido Günther <agx@sigxcpu.org> wrote:

> When an object can be considered close to the sensor is hardware
> dependent. Allowing to configure the property via device tree
> allows to configure this device specific value.
> 
> This is useful for e.g. iio-sensor-proxy to indicate to userspace
> if an object is close to the sensor.
> 
> Signed-off-by: Guido Günther <agx@sigxcpu.org>
Applied.  Thanks,
> ---
>  drivers/iio/light/vcnl4000.c | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/drivers/iio/light/vcnl4000.c b/drivers/iio/light/vcnl4000.c
> index ec803c1e81df..985cc39ede8e 100644
> --- a/drivers/iio/light/vcnl4000.c
> +++ b/drivers/iio/light/vcnl4000.c
> @@ -83,6 +83,7 @@ struct vcnl4000_data {
>  	struct mutex vcnl4000_lock;
>  	struct vcnl4200_channel vcnl4200_al;
>  	struct vcnl4200_channel vcnl4200_ps;
> +	uint32_t near_level;
>  };
>  
>  struct vcnl4000_chip_spec {
> @@ -343,6 +344,25 @@ static const struct vcnl4000_chip_spec vcnl4000_chip_spec_cfg[] = {
>  	},
>  };
>  
> +static ssize_t vcnl4000_read_near_level(struct iio_dev *indio_dev,
> +					uintptr_t priv,
> +					const struct iio_chan_spec *chan,
> +					char *buf)
> +{
> +	struct vcnl4000_data *data = iio_priv(indio_dev);
> +
> +	return sprintf(buf, "%u\n", data->near_level);
> +}
> +
> +static const struct iio_chan_spec_ext_info vcnl4000_ext_info[] = {
> +	{
> +		.name = "nearlevel",
> +		.shared = IIO_SEPARATE,
> +		.read = vcnl4000_read_near_level,
> +	},
> +	{ /* sentinel */ }
> +};
> +
>  static const struct iio_chan_spec vcnl4000_channels[] = {
>  	{
>  		.type = IIO_LIGHT,
> @@ -351,6 +371,7 @@ static const struct iio_chan_spec vcnl4000_channels[] = {
>  	}, {
>  		.type = IIO_PROXIMITY,
>  		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
> +		.ext_info = vcnl4000_ext_info,
>  	}
>  };
>  
> @@ -440,6 +461,10 @@ static int vcnl4000_probe(struct i2c_client *client,
>  	dev_dbg(&client->dev, "%s Ambient light/proximity sensor, Rev: %02x\n",
>  		data->chip_spec->prod, data->rev);
>  
> +	if (device_property_read_u32(&client->dev, "proximity-near-level",
> +				     &data->near_level))
> +		data->near_level = 0;
> +
>  	indio_dev->dev.parent = &client->dev;
>  	indio_dev->info = &vcnl4000_info;
>  	indio_dev->channels = vcnl4000_channels;
Jonathan Cameron April 18, 2020, 6:06 p.m. UTC | #2
On Sun,  5 Apr 2020 15:50:32 +0200
Guido Günther <agx@sigxcpu.org> wrote:

> The vcnl4000 IIO driver introduced a new attribute
> "in_proximity_nearlevel".  This adds it to the list of documented ABI
> for sysfs-bus-iio.
> 
> Signed-off-by: Guido Günther <agx@sigxcpu.org>

Applied to the togreg branch of iio.git and pushed out as testing for the
autobuilders to play with it.

Thanks,

Jonathan

> ---
>  Documentation/ABI/testing/sysfs-bus-iio-proximity | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-proximity
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-proximity b/Documentation/ABI/testing/sysfs-bus-iio-proximity
> new file mode 100644
> index 000000000000..2172f3bb9c64
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-proximity
> @@ -0,0 +1,10 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_proximity_nearlevel
> +Date:		March 2020
> +KernelVersion:	5.7
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		Near level for proximity sensors. This is a single integer
> +		value that tells user space when an object should be
> +		considered close to the device. If the value read from the
> +		sensor is above or equal to the value in this file an object
> +		should typically be considered near.