From: Waqar Hameed <waqar.hameed@axis.com>
To: Jonathan Cameron <jic23@kernel.org>
Cc: Lars-Peter Clausen <lars@metafoo.de>,
<linux-kernel@vger.kernel.org>, <linux-iio@vger.kernel.org>,
<kernel@axis.com>
Subject: Re: [PATCH 2/2] iio: Add driver for Murata IRS-D200
Date: Mon, 19 Jun 2023 13:24:28 +0200 [thread overview]
Message-ID: <pndo7lb1mes.fsf@axis.com> (raw)
In-Reply-To: <20230617143508.28309834@jic23-huawei>
On Sat, Jun 17, 2023 at 14:35 +0100 Jonathan Cameron <jic23@kernel.org> wrote:
> On Fri, 16 Jun 2023 17:10:42 +0200
> Waqar Hameed <waqar.hameed@axis.com> wrote:
>
>> Murata IRS-D200 is a PIR sensor for human detection. It has support for
>> raw data measurements and detection event notification.
>>
>> Add a driver with support for triggered buffer and events. Map the
>> various settings to the `iio` framework, e.g. threshold values, sampling
>> frequency, filter frequencies etc.
>>
>> Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
>
> Hi Waqar,
>
> Generally looks pretty good to me.
> A few comments inline to add to Lars-Peter's review.
Thank you for your thorough review!
>> diff --git a/drivers/iio/proximity/irsd200.c b/drivers/iio/proximity/irsd200.c
>> new file mode 100644
>> index 000000000000..699801d60295
>> --- /dev/null
>> +++ b/drivers/iio/proximity/irsd200.c
>> @@ -0,0 +1,1051 @@
>> +// SPDX-License-Identifier: GPL-2.0-only
>> +/*
>> + * Driver for Murata IRS-D200 PIR sensor.
>> + *
>> + * Copyright (C) 2023 Axis Communications AB
>> + */
>> +
>> +#include <linux/gpio.h>
>> +#include <linux/i2c.h>
>> +#include <linux/module.h>
>> +#include <linux/regmap.h>
>> +
>> +#include <linux/iio/buffer.h>
>> +#include <linux/iio/events.h>
>> +#include <linux/iio/iio.h>
>> +#include <linux/iio/trigger.h>
>> +#include <linux/iio/trigger_consumer.h>
>> +#include <linux/iio/triggered_buffer.h>
>> +#include <linux/iio/types.h>
>> +
>> +#define IRS_DRV_NAME "irsd200"
>> +
>> +/* Registers. */
>> +#define IRS_REG_OP 0x00 /* Operation mode. */
>> +#define IRS_REG_DATA_LO 0x02 /* Sensor data LSB. */
>> +#define IRS_REG_DATA_HI 0x03 /* Sensor data MSB. */
>> +#define IRS_REG_STATUS 0x04 /* Interrupt status. */
>> +#define IRS_REG_COUNT 0x05 /* Count of exceeding threshold. */
>> +#define IRS_REG_DATA_RATE 0x06 /* Output data rate. */
>> +#define IRS_REG_FILTER 0x07 /* High-pass and low-pass filter. */
>> +#define IRS_REG_INTR 0x09 /* Interrupt mode. */
>> +#define IRS_REG_NR_COUNT 0x0a /* Number of counts before interrupt. */
>> +#define IRS_REG_THR_HI 0x0b /* Upper threshold. */
>> +#define IRS_REG_THR_LO 0x0c /* Lower threshold. */
>> +#define IRS_REG_TIMER_LO 0x0d /* Timer setting LSB. */
>> +#define IRS_REG_TIMER_HI 0x0e /* Timer setting MSB. */
>> +
>> +/* Interrupt status bits. */
>> +#define IRS_INTR_DATA 0 /* Data update. */
>> +#define IRS_INTR_TIMER 1 /* Timer expiration. */
>> +#define IRS_INTR_COUNT_THR_AND 2 /* Count "AND" threshold. */
>> +#define IRS_INTR_COUNT_THR_OR 3 /* Count "OR" threshold. */
>> +
>> +/*
>> + * Quantization scale value for threshold. Used for conversion from/to register
>> + * value.
>> + */
>> +#define IRS_THR_QUANT_SCALE 128
>> +
>> +/*
>> + * The upper 4 bits in register IRS_REG_COUNT value is the upper count value
>> + * (exceeding upper threshold value). The lower 4 is the lower count value
>> + * (exceeding lower threshold value).
>
> Code makes this obvious. This is just a comment that might become wrong in
> future (adds little) - so I'd drop it.
I understand, will do!
>> + */
>> +#define IRS_UPPER_COUNT(count) (count >> 4)
>> +#define IRS_LOWER_COUNT(count) (count & GENMASK(3, 0))
>
> What Lars said on this one ((count) & GENMAKS(3, 0)
>
> or better yet FIELD_GET() with appropriately defined mask for each of these
> as that is more readable in general.
I agree, `FIELD_GET()` is better.
>> +/*
>> + * Index corresponds to the (field) value of IRS_REG_FILTER register. Contains
>> + * only the fractional part (since the integer part is 0, e.g the first value
>> + * corresponds to 0.3 Hz).
>> + */
>> +static const unsigned int irsd200_hp_filter_freq[2] = {
>
> [] probably easier. Means reviewer doesn't need to sanity the length.
Alright.
>> + 3,
>> + 5,
>> +};
>
>> +
>> +static int irsd200_setup(struct irsd200_data *data)
>> +{
>> + unsigned int val;
>> + int ret;
>> +
>> + /* Disable all interrupt sources. */
>
> I assume the device doesn't provide any means of resetting it to get a known
> register state? Bit unusual to need to disable interrupts rather than be
> able to assume they are already disabled.
There is no dedicated reset (other than explicitly power cycle it of
course). I mean, according to the data sheet, the default value is zero
(i.e. interrupt disabled). It wouldn't hurt to be really sure here,
right?
This register and IRS_REG_OP below are the important one to be sure
about during the setup (we want to be sure that it is in _this_ state
here).
>> + ret = regmap_write(data->regmap, IRS_REG_INTR, 0);
>> + if (ret) {
>> + dev_err(data->dev, "Could not set interrupt sources (%d)\n",
>> + ret);
>> + return ret;
>> + }
>> +
>> + /* Set operation to active. */
>> + ret = regmap_write(data->regmap, IRS_REG_OP, 0x00);
>
> That 0 value probably wants a define.
Yeah, I'll add that.
>> + if (ret) {
>> + dev_err(data->dev, "Could not set operation mode (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + /* Clear threshold count. */
>> + ret = regmap_read(data->regmap, IRS_REG_COUNT, &val);
>> + if (ret) {
>> + dev_err(data->dev, "Could not clear threshold count (%d)\n",
>> + ret);
>> + return ret;
>> + }
>> +
>> + /* Clear status. */
>> + ret = regmap_write(data->regmap, IRS_REG_STATUS, 0x0f);
>> + if (ret) {
>> + dev_err(data->dev, "Could not clear status (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + return 0;
>> +}
>> +
>
>> +
>> +static int irsd200_read_data(struct irsd200_data *data, s16 *val)
>> +{
>> + unsigned int tmpval;
>> + int ret;
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_DATA_HI, &tmpval);
>> + if (ret < 0) {
>> + dev_err(data->dev, "Could not read hi data (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + *val = (s16)(tmpval << 8);
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_DATA_LO, &tmpval);
>> + if (ret < 0) {
>> + dev_err(data->dev, "Could not read lo data (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + *val |= tmpval;
>
> As below - bulk read and endian conversion if possible.
Yes, will use `regmap_bulk_read()`.
>> +
>> + return 0;
>> +}
>> +
>> +stan 0;
(What happened here?)
>> +}
>> +
>> +static int irsd200_write_data_rate(struct irsd200_data *data, int val)
>> +{
>> + size_t idx;
>> + int ret;
>> +
>> + for (idx = 0; idx < ARRAY_SIZE(irsd200_data_rates); ++idx) {
>> + if (irsd200_data_rates[idx] == val)
>> + break;
>> + }
>> +
>> + if (idx == ARRAY_SIZE(irsd200_data_rates))
>> + return -ERANGE;
>> +
>> + ret = regmap_write(data->regmap, IRS_REG_DATA_RATE, idx);
>> + if (ret < 0) {
>> + dev_err(data->dev, "Could not write data rate (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + /* Data sheet says the device needs 3 seconds of settling time. */
>> + ssleep(3);
> You aren't preventing other userspace reads / writes during that time so
> this is a light protection at best.
Yes, we aren't preventing anything. The hardware actually operates
without any "errors" during this period (e.g. buffer data and events
keep arriving).
This is more of a guarantee that "within 3 s, the new data rate should
be in effect". When I think about it, we should maybe just remove this
sleep?
>> +
>> + return 0;
>> +}
>> +
>> +static int irsd200_read_timer(struct irsd200_data *data, int *val, int *val2)
>> +{
>> + unsigned int tmpval;
>> + unsigned int regval;
>> + int ret;
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_TIMER_HI, &tmpval);
>> + if (ret < 0) {
>> + dev_err(data->dev, "Could not read hi timer (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + /* Value is 10 bits. IRS_REG_TIMER_HI is the two MSBs. */
>> + regval = tmpval << 8;
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_TIMER_LO, &tmpval);
>> + if (ret < 0) {
>> + dev_err(data->dev, "Could not read lo timer (%d)\n", ret);
>> + return ret;
>> + }
>
> Bulk read and endian conversion preferred for this as Lars pointed out.
> Help with various thing including preventing tearing of the value if someone
> else is writing whilst it is being read.
>
> In general, you may want to look at using a local lock to ensure consistent
> state whenever there are multiple reads / writes in a given function that userspace
> can cause to be called.
Yeah, will use bulk read here as well.
[...]
>> +static int irsd200_write_hp_filter(struct irsd200_data *data, int val, int val2)
>> +{
>> + size_t idx;
>> + int ret;
>> +
>> + /* Truncate fractional part to one digit. */
>> + val2 /= 100000;
>> +
>> + for (idx = 0; idx < ARRAY_SIZE(irsd200_hp_filter_freq); ++idx) {
>> + if (irsd200_hp_filter_freq[idx] == val2)
>> + break;
>> + }
>> +
>> + if (idx == ARRAY_SIZE(irsd200_hp_filter_freq) || val != 0)
>> + return -ERANGE;
>> +
>> + ret = regmap_field_write(data->regfields[IRS_REGF_HP_FILTER], idx);
>> + if (ret < 0) {
>
> For regmap calls, they are (I think) all documented as returning 0 for success
> and negative otherwise. That lets you both check the simpler if (ret) and ...
Maybe it _is_ too defensive here. However, I have encountered APIs where
positive values can/has been returned (due to debug/testing or just plain
slip ups), without any actual errors.
However, let's trust `regmap` then. I can change to only look for `if
(ret)` everywhere.
>
>> + dev_err(data->dev, "Could not write hp filter frequency (%d)\n",
>> + ret);
>> + return ret;
>
> drop this return ret out of the if block here.
>
> In general being able to ignore possibility of ret > 0 simplifies handling.
I try to be consistent and it also "helps" the next person potentially
adding code after the `if`-statement and forgetting about adding
`return`. We can drop the `return here, but then we should do the same
in other places with a check just before the last `return` (like
`irsd200_write_timer()`, `irsd200_read_nr_count()`,
`irsd200_write_nr_count()` and many more), right?
[...]
>> +
>> +static int irsd200_write_event(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)
>> +{
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> +
>> + switch (info) {
>> + case IIO_EV_INFO_VALUE:
>> + return irsd200_write_threshold(data, dir, val);
>> + case IIO_EV_INFO_TIMEOUT:
>> + return irsd200_write_timer(data, val, val2);
>> + case IIO_EV_INFO_PERIOD:
>> + return irsd200_write_nr_count(data, val);
>> + case IIO_EV_INFO_LOW_PASS_FILTER_3DB:
>> + return irsd200_write_lp_filter(data, val);
>> + case IIO_EV_INFO_HIGH_PASS_FILTER_3DB:
>> + return irsd200_write_hp_filter(data, val, val2);
>
> Just to check - filtering is only on the data being used for events? Not
> on the direct readback of the data? Whilst that happens, it's not all that
> common - hence the check.
Well spotted! It actually made think here! :)
I do think it applies to the raw data (as well). Comparing that to
`IIO_CHAN_INFO_SAMP_FREQ` (which also affects the events) we should
therefore probably move the filtering to `struct iio_chan_spec
irsd200_channels`, right?
[...]
>> +static int irsd200_write_event_config(struct iio_dev *indio_dev,
>> + const struct iio_chan_spec *chan,
>> + enum iio_event_type type,
>> + enum iio_event_direction dir, int state)
>> +{
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> + unsigned int val;
>> + int ret;
>> +
>> + switch (type) {
>> + case IIO_EV_TYPE_THRESH:
>> + /*
>> + * There is no way to tell the hardware to only signal for a
>> + * single direction. Let's just group IIO_EV_DIR_RISING and
>> + * IIO_EV_DIR_FALLING together instead of doing extra
>> + * (unnecessary) post-processing after an interrupt.
>> + */
> If you can't control them separately then you should use the EITHER direction
> for the enable. That means you get in_proximity_thresh_en
> covering both thresholds.
Ah, of course! I'll change!
>> +
>> + /* Clear the count register (by reading from it). */
>> + ret = regmap_read(data->regmap, IRS_REG_COUNT, &val);
>> + if (ret < 0)
>> + return ret;
>> +
>> + val = !!state;
>> + ret = regmap_field_write(
>> + data->regfields[IRS_REGF_INTR_COUNT_THR_OR], val);
>> + if (ret < 0)
>> + return ret;
>> +
>> + return val;
>> + case IIO_EV_TYPE_CHANGE:
>> + val = !!state;
>> + ret = regmap_field_write(data->regfields[IRS_REGF_INTR_TIMER],
>> + val);
>> + if (ret < 0)
>> + return ret;
>> +
>> + return val;
>> + default:
>> + return -EINVAL;
>> + }
>> +}
>> +
>> +static irqreturn_t irsd200_irq_thread(int irq, void *dev_id)
>> +{
>> + struct iio_dev *indio_dev = dev_id;
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> + enum iio_event_direction dir;
>> + unsigned int lower_count;
>> + unsigned int upper_count;
>> + unsigned int status = 0;
>> + unsigned int source = 0;
>> + unsigned int clear = 0;
>> + unsigned int count = 0;
>> + int ret;
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_INTR, &source);
>> + if (ret) {
>> + dev_err(data->dev, "Could not read interrupt source (%d)\n",
>> + ret);
>> + return IRQ_NONE;
>> + }
>> +
>> + ret = regmap_read(data->regmap, IRS_REG_STATUS, &status);
>> + if (ret) {
>> + dev_err(data->dev, "Could not acknowledge interrupt (%d)\n",
>> + ret);
>> + return IRQ_NONE;
>> + }
>> +
>> + if (status & BIT(IRS_INTR_DATA) && iio_buffer_enabled(indio_dev)) {
>> + iio_trigger_poll_nested(indio_dev->trig);
>> + clear |= BIT(IRS_INTR_DATA);
>> + }
>> +
>> + if (status & BIT(IRS_INTR_TIMER) && source & BIT(IRS_INTR_TIMER)) {
>> + iio_push_event(indio_dev,
>> + IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
>> + IIO_EV_TYPE_CHANGE,
>> + IIO_EV_DIR_NONE),
>
> As below, I'd like more explanation of what this is.
> I can't find a datasheet to look it up in.
This is a timer for the detection event window time, i.e. the signal
should pass the threshold values within this time in order to get an
interrupt (`IIO_EV_TYPE_THRESH`).
You setup the window time (`IIO_EV_INFO_TIMEOUT`), and when this timer
has expired, you get this interrupt (and thus `IIO_EV_TYPE_CHANGE`). I
couldn't find any other more fitting value in `enum iio_event_type`.
>> + iio_get_time_ns(indio_dev));
>> + clear |= BIT(IRS_INTR_TIMER);
>> + }
>> +
>> + if (status & BIT(IRS_INTR_COUNT_THR_OR) &&
>> + source & BIT(IRS_INTR_COUNT_THR_OR)) {
>> + /*
>> + * The register value resets to zero after reading. We therefore
>> + * need to read once and manually extract the lower and upper
>> + * count register fields.
>> + */
>> + ret = regmap_read(data->regmap, IRS_REG_COUNT, &count);
>> + if (ret)
>> + dev_err(data->dev, "Could not read count (%d)\n", ret);
>> +
>> + upper_count = IRS_UPPER_COUNT(count);
>> + lower_count = IRS_LOWER_COUNT(count);
>> +
>> + /*
>> + * We only check the OR mode to be able to push events for
>> + * rising and falling thresholds. AND mode is covered when both
>> + * upper and lower count is non-zero, and is signaled with
>> + * IIO_EV_DIR_EITHER.
>
> Whey you say AND, you mean that both thresholds have been crossed but also that
> in that configuration either being crossed would also have gotten us to here?
> (as opposed to the interrupt only occurring if value is greater than rising threshold
> and less than falling threshold?)
>
> If it's the first then just report two events. Either means we don't know, rather
> than we know both occurred. We don't document that well though - so something
> we should improved there. whilst a bit confusing:
> https://elixir.bootlin.com/linux/v6.4-rc6/source/Documentation/ABI/testing/sysfs-bus-iio#L792
> talks about this.
>
> The bracketed case is more annoying to deal with so I hope you don't mean that.
> Whilst we've had sensors that support it in hardware for years, I don't think we
> ever came up with a usecase that really justified describing it.
According to the data sheet (which will hopefully be soon publicly
available):
OR-interrupt: (UPPER_COUNT + LOWER_COUNT >= NR_COUNT)
AND-interrupt: (UPPER_COUNT + LOWER_COUNT >= NR_COUNT) &&
(UPPER_COUNT != 0) && (LOWER_COUNT != 0)
For example, consider the following situation:
___
/ \
-----------------------------3------------------- Upper threshold
___ / \
______ / \ / \___________ Data signal
\ / \ /
-------1------------2---------------------------- Lower threshold
\__/ \__/
When `NR_COUNT` is set to 3, we will get an OR-interrupt on point "3" in
the graph above. In this case `UPPER_COUNT = 1` and `LOWER_COUNT = 2`.
When `NR_COUNT` is set to 2, we will get an OR-interrupt on point "2"
instead. Here `UPPER_COUNT = 0` and `LOWER_COUNT = 2`.
>
>> + */
>> + if (upper_count && !lower_count)
>> + dir = IIO_EV_DIR_RISING;
>> + else if (!upper_count && lower_count)
>> + dir = IIO_EV_DIR_FALLING;
>> + else
>> + dir = IIO_EV_DIR_EITHER;
>> +
>> + iio_push_event(indio_dev,
>> + IIO_UNMOD_EVENT_CODE(IIO_PROXIMITY, 0,
>> + IIO_EV_TYPE_THRESH, dir),
>> + iio_get_time_ns(indio_dev));
>> +
>> + /*
>> + * The OR mode will always trigger when the AND mode does, but
>> + * not vice versa. However, it seems like the AND bit needs to
>> + * be cleared if data capture _and_ threshold count interrupts
>> + * are desirable, even though it hasn't explicitly been selected
>> + * (with IRS_REG_INTR). Either way, it doesn't hurt...
>> + */
>> + clear |= BIT(IRS_INTR_COUNT_THR_OR) |
>> + BIT(IRS_INTR_COUNT_THR_AND);
>> + }
>> +
>> + if (clear) {
>> + ret = regmap_write(data->regmap, IRS_REG_STATUS, clear);
>> + if (ret)
>> + dev_err(data->dev,
>> + "Could not clear interrupt status (%d)\n", ret);
>> + }
>> +
>> + return IRQ_HANDLED;
>> +}
>> +
>> +static irqreturn_t irsd200_trigger_handler(int irq, void *pollf)
>> +{
>> + struct iio_dev *indio_dev = ((struct iio_poll_func *)pollf)->indio_dev;
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> + s16 buf = 0;
>> + int ret;
>> +
>> + ret = irsd200_read_data(data, &buf);
>> + if (ret)
>> + goto end;
>> +
>> + iio_push_to_buffers_with_timestamp(indio_dev, &buf,
>> + iio_get_time_ns(indio_dev));
>> +
>> +end:
>> + iio_trigger_notify_done(indio_dev->trig);
>> +
>> + return ret ? IRQ_NONE : IRQ_HANDLED;
>> +}
>> +
>> +static int irsd200_buf_postenable(struct iio_dev *indio_dev)
>> +{
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> + int ret;
>> +
>> + ret = regmap_field_write(data->regfields[IRS_REGF_INTR_DATA], 1);
>
> This looks to be turning on the interrupt.
> Whilst the abstract trigger driving capture into a buffer model doesn't always
> cleanly fit a driver architecture, in this case this seems like it should be
> in the set_trigger_state() callback not here.
Alright, I'll move them to `set_trigger_state()`.
>
>
>> + if (ret) {
>> + dev_err(data->dev,
>> + "Could not enable data interrupt source (%d)\n", ret);
>> + }
>> +
>> + return ret;
>> +}
>> +
>> +static int irsd200_buf_predisable(struct iio_dev *indio_dev)
>> +{
>> + struct irsd200_data *data = iio_priv(indio_dev);
>> + int ret;
>> +
>> + ret = regmap_field_write(data->regfields[IRS_REGF_INTR_DATA], 0);
>> + if (ret) {
>> + dev_err(data->dev,
>> + "Could not disable data interrupt source (%d)\n", ret);
>> + }
>> +
>> + return ret;
>> +}
>> +
[...]
>> +static const struct iio_event_spec irsd200_event_spec[] = {
>> + /* Upper threshold value. */
> As below, the code is pretty much self documenting, so I'd drop
> comments that can just become out of date. Comments are good when they
> add information but here I don't think they do.
Will remove!
>> + {
>> + .type = IIO_EV_TYPE_THRESH,
>> + .dir = IIO_EV_DIR_RISING,
>> + .mask_separate =
>> + BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
>> + },
>> + /* Lower threshold value. */
>> + {
>> + .type = IIO_EV_TYPE_THRESH,
>> + .dir = IIO_EV_DIR_FALLING,
>> + .mask_separate =
>> + BIT(IIO_EV_INFO_VALUE) | BIT(IIO_EV_INFO_ENABLE),
>> + },
>> + /* Window time. */
>> + {
>> + .type = IIO_EV_TYPE_CHANGE,
>> + .dir = IIO_EV_DIR_NONE,
>> + .mask_separate =
>> + BIT(IIO_EV_INFO_TIMEOUT) | BIT(IIO_EV_INFO_ENABLE),
>
> This is unusual use of ABI. Please given some more detail on what it is.
Explained above.
>
>> + },
>> + /* Number of counts (exceeding thresholds) before interrupt. */
>> + {
>> + .type = IIO_EV_TYPE_THRESH,
>> + .dir = IIO_EV_DIR_EITHER,
>> + .mask_separate = BIT(IIO_EV_INFO_PERIOD),
>> + },
>> + /* Low-pass filter frequency. */
>
> Documentation doesn't add anything over code, so drop it.
> Also combined all these cases where type and dir match into one entry
> with multiple bits set in mask_separate etc.
Will do!
>
>> + {
>> + .type = IIO_EV_TYPE_THRESH,
>> + .dir = IIO_EV_DIR_EITHER,
>> + .mask_separate = BIT(IIO_EV_INFO_LOW_PASS_FILTER_3DB),
>> + },
>> + /* High-pass filter frequency. */
>> + {
>> + .type = IIO_EV_TYPE_THRESH,
>> + .dir = IIO_EV_DIR_EITHER,
>> + .mask_separate = BIT(IIO_EV_INFO_HIGH_PASS_FILTER_3DB),
>> + },
>> +};
>
>> +};
>> +
>> +static int irsd200_probe(struct i2c_client *client)
>> +{
>> + struct iio_trigger *trigger;
>> + struct irsd200_data *data;
>> + struct iio_dev *indio_dev;
>> + struct regmap *regmap;
>> + size_t i;
>> + int ret;
>> +
>> + regmap = devm_regmap_init_i2c(client, &irsd200_regmap_config);
>> + if (IS_ERR(regmap)) {
>> + dev_err(&client->dev, "Could not initialize regmap\n");
>> + return PTR_ERR(regmap);
>> + }
>> +
>> + indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
>> + if (!indio_dev) {
>> + dev_err(&client->dev, "Could not allocate iio device\n");
>> + return -ENOMEM;
>> + }
>> +
>> + data = iio_priv(indio_dev);
>> + data->regmap = regmap;
>> + data->dev = &client->dev;
>> + i2c_set_clientdata(client, indio_dev);
>
> I'm not seeing any where this is ready back... Don't set it unless you need
> it.
You are right.
>
>> +
>> + for (i = 0; i < IRS_REGF_MAX; ++i) {
>> + data->regfields[i] = devm_regmap_field_alloc(
>> + data->dev, data->regmap, irsd200_regfields[i]);
>> + if (IS_ERR(data->regfields[i])) {
>> + dev_err(data->dev,
>> + "Could not allocate register field %zu\n", i);
>> + return PTR_ERR(data->regfields[i]);
>> + }
>> + }
>> +
>> + ret = irsd200_setup(data);
>> + if (ret)
>> + return ret;
>> +
>> + indio_dev->info = &irsd200_info;
>> + indio_dev->name = IRS_DRV_NAME;
>> + indio_dev->channels = irsd200_channels;
>> + indio_dev->num_channels = ARRAY_SIZE(irsd200_channels);
>> + indio_dev->modes = INDIO_DIRECT_MODE;
>> +
>> + if (!client->irq) {
>> + dev_err(&client->dev, "No irq available\n");
>> + return -ENXIO;
>> + }
>> +
>> + ret = devm_iio_triggered_buffer_setup(&client->dev, indio_dev, NULL,
>> + irsd200_trigger_handler,
>> + &irsd200_buf_ops);
>> + if (ret) {
>> + dev_err(&client->dev,
>> + "Could not setup iio triggered buffer (%d)\n", ret);
>> + return ret;
>> + }
>> +
>> + ret = devm_request_threaded_irq(&client->dev, client->irq, NULL,
>> + irsd200_irq_thread,
>> + IRQF_TRIGGER_RISING | IRQF_ONESHOT,
>> + NULL, indio_dev);
>> + if (ret) {
>> + return dev_err_probe(&client->dev, ret,
>> + "Could not request irq (%d)\n", ret);
>> + }
> Brackets not needed. Doesn't matter as a one off, but if you take
> a lot more of these to dev_err_probe() like here then it will shorten
> your code a fair bit and make it slightly easier to review (more on the
> screen at a time etc).
Interesting that `checkpatch.pl` missed this one. Yes, I'll change to
`dev_err_probe()`.
> As noted in DT binding review, it's definitely a good thing to support
> basic operation in the absence of the interrupt line being wired up.
> Normally that involves not registering all the stuff that needs the interrupt
> and providing alternative iio_info, channels and some polling code to
> us for data ready detection. On majority of hardware you can make triggered
> buffers work without interrupts (driven by an hrtimer trigger or similar)
> so you keep that available for both interrupt and non interrupt cases.
Answered there.
>> +
>> + trigger = devm_iio_trigger_alloc(&client->dev, "%s-dev%d",
>> + indio_dev->name,
>> + iio_device_id(indio_dev));
>> + if (!trigger) {
>> + dev_err(&client->dev, "Could not allocate iio trigger\n");
>> + return -ENOMEM;
>> + }
>> +
>> + trigger->ops = &irsd200_trigger_ops;
>> + iio_trigger_set_drvdata(trigger, indio_dev);
>> +
>> + ret = devm_iio_trigger_register(&client->dev, trigger);
>> + if (ret) {
>> + dev_err(&client->dev, "Could not register iio trigger (%d)\n",
>> + ret);
>> + return ret;
>> + }
>> +
>> + ret = devm_iio_device_register(&client->dev, indio_dev);
>> + if (ret) {
>> + dev_err(&client->dev, "Could not register iio device (%d)\n",
>> + ret);
>> + return ret;
>
> Lars pointed this out already. It is fine (and generally a good idea) to
> use dev_err_probe() for paths like this in probe. Some of it's functionality
> is irrelevant (the deferred handling) but it does no harm in other paths and
> makes the code more compact and easier to review.
Yeah, I'll change to `dev_err_probe()`.
>
>> + }
>> +
>> + return 0;
>> +}
next prev parent reply other threads:[~2023-06-19 15:50 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-16 15:10 [PATCH 0/2] Add driver for Murata IRS-D200 Waqar Hameed
2023-06-16 15:10 ` [PATCH 2/2] iio: " Waqar Hameed
2023-06-17 1:37 ` Lars-Peter Clausen
2023-06-19 11:21 ` Waqar Hameed
2023-06-17 13:35 ` Jonathan Cameron
2023-06-19 11:24 ` Waqar Hameed [this message]
2023-06-25 11:06 ` Jonathan Cameron
2023-06-30 8:54 ` Waqar Hameed
2023-07-02 10:42 ` Jonathan Cameron
2023-07-03 8:59 ` Waqar Hameed
2023-07-05 7:50 ` Jonathan Cameron
2023-07-12 15:33 ` Waqar Hameed
2023-07-15 16:51 ` Jonathan Cameron
2023-06-16 15:10 ` [PATCH 1/2] dt-bindings: iio: proximity: Add bindings " Waqar Hameed
2023-06-17 8:55 ` Krzysztof Kozlowski
2023-06-19 10:40 ` Waqar Hameed
2023-06-19 11:29 ` Krzysztof Kozlowski
2023-06-17 12:55 ` Jonathan Cameron
2023-06-19 10:41 ` Waqar Hameed
2023-07-02 10:34 ` Jonathan Cameron
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=pndo7lb1mes.fsf@axis.com \
--to=waqar.hameed@axis.com \
--cc=jic23@kernel.org \
--cc=kernel@axis.com \
--cc=lars@metafoo.de \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.