Re: [PATCH 1/2] bu27034: ROHM BU27034NUC to BU27034ANUC

[Jonathan Cameron]

On Mon, 10 Jun 2024 13:01:23 +0300
Matti Vaittinen <mazziesaccount@xxxxxxxxx> wrote:

> The ROHM BU27034NUC was cancelled and BU27034ANUC is replacing this
> sensor. Use the BU27034NUC driver to support the new BU27034ANUC.
> 
> According to ROHM, the BU27034NUC was never mass-produced. Hence dropping
> the BU27034NUC support and using this driver to support BU27034ANUC
> should not be a problem to users.
> 
> Signed-off-by: Matti Vaittinen <mazziesaccount@xxxxxxxxx>
> Fixes: e52afbd61039 ("iio: light: ROHM BU27034 Ambient Light Sensor")

This is an odd case.  I don't think a fixes tag is appropriate and I
don't think we can use the original compatible.  I don't mind breaking
support for the non existent port going forwards and indeed dropping
all indication it ever existed, but the old kernel's are out there and
even getting this into stable is far from a guarantee there won't be
a kernel run on a board that has this compatible but has the old
driver.  It's also too big really to be stable material.

So I think the path forwards is a new compatible and drop the old
one from the dt bindings and driver.  Thus any new dts for a board
that actually has this device will use the new compatible and avoid
any risk of encountering the old driver.

Maybe we can be more relaxed - what actually happens if you use the
existing driver with the new part?

I'm trusting you copied the maths right for the computed
channels (that take too long to review!)  So everything inline is
formatting type stuff.

> ---
>  drivers/iio/light/rohm-bu27034.c | 321 +++++++------------------------
>  1 file changed, 68 insertions(+), 253 deletions(-)
> 
> diff --git a/drivers/iio/light/rohm-bu27034.c b/drivers/iio/light/rohm-bu27034.c
> index bf3de853a811..51acad2cafbd 100644
> --- a/drivers/iio/light/rohm-bu27034.c
> +++ b/drivers/iio/light/rohm-bu27034.c

...

>  /*
> - * Available scales with gain 1x - 4096x, timings 55, 100, 200, 400 mS
> + * Available scales with gain 1x - 1024x, timings 55, 100, 200, 400 mS
>   * Time impacts to gain: 1x, 2x, 4x, 8x.
>   *
> - * => Max total gain is HWGAIN * gain by integration time (8 * 4096) = 32768
> + * => Max total gain is HWGAIN * gain by integration time (8 * 1024) = 8192
> + * if 1x gain is scale 1, scale for 2x gain is 0.5, 4x => 0.25,
> + * ... 8192x => 0.0001220703125 => 122070.3125 nanos
>   *
> - * Using NANO precision for scale we must use scale 64x corresponding gain 1x
> - * to avoid precision loss. (32x would result scale 976 562.5(nanos).
> + * Using NANO precision for scale, we must use scale 16x corresponding gain 1x
> + * to avoid precision loss. (8x would result scale 976 562.5(nanos).
>   */
> -#define BU27034_SCALE_1X	64
> +#define BU27034_SCALE_1X	16

...

> -#define BU27034_CHAN_DATA(_name, _ch2)					\
> +#define BU27034_CHAN_DATA(_name)					\
>  {									\
>  	.type = IIO_INTENSITY,						\
>  	.channel = BU27034_CHAN_##_name,				\
> -	.channel2 = (_ch2),						\
> +	.channel2 = IIO_MOD_LIGHT_CLEAR,				\
>  	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |			\
>  			      BIT(IIO_CHAN_INFO_SCALE),			\
>  	.info_mask_separate_available = BIT(IIO_CHAN_INFO_SCALE),	\
> @@ -195,13 +182,12 @@ static const struct iio_chan_spec bu27034_channels[] = {
>  	/*
>  	 * The BU27034 DATA0 and DATA1 channels are both on the visible light
>  	 * area (mostly). The data0 sensitivity peaks at 500nm, DATA1 at 600nm.
> -	 * These wave lengths are pretty much on the border of colours making
> -	 * these a poor candidates for R/G/B standardization. Hence they're both
> -	 * marked as clear channels
> +	 * These wave lengths are cyan(ish) and orange(ish), making these
> +	 * sub-optiomal candidates for R/G/B standardization. Hence they're
> +	 * both marked as clear channels.

I think just indexing them and not giving a modifier is probably better than
claiming they are clear.  Leave it more vague basically.

>  	 */
> -	BU27034_CHAN_DATA(DATA0, IIO_MOD_LIGHT_CLEAR),
> -	BU27034_CHAN_DATA(DATA1, IIO_MOD_LIGHT_CLEAR),
> -	BU27034_CHAN_DATA(DATA2, IIO_MOD_LIGHT_IR),
> +	BU27034_CHAN_DATA(DATA0),
> +	BU27034_CHAN_DATA(DATA1),
>  	IIO_CHAN_SOFT_TIMESTAMP(4),
>  };

> @@ -281,39 +261,15 @@ static int bu27034_get_gain_sel(struct bu27034_data *data, int chan)
>  {
>  	int ret, val;
>  
Probably no blank line here.

> -	switch (chan) {
> -	case BU27034_CHAN_DATA0:
> -	case BU27034_CHAN_DATA1:
> -	{
> -		int reg[] = {
> -			[BU27034_CHAN_DATA0] = BU27034_REG_MODE_CONTROL2,
> -			[BU27034_CHAN_DATA1] = BU27034_REG_MODE_CONTROL3,
> -		};
> -		ret = regmap_read(data->regmap, reg[chan], &val);
> -		if (ret)
> -			return ret;
> -
> -		return FIELD_GET(BU27034_MASK_D01_GAIN, val);
> -	}
> -	case BU27034_CHAN_DATA2:
> -	{
> -		int d2_lo_bits = fls(BU27034_MASK_D2_GAIN_LO);
> -
> -		ret = regmap_read(data->regmap, BU27034_REG_MODE_CONTROL2, &val);
> -		if (ret)
> -			return ret;
> +	int reg[] = {
> +		[BU27034_CHAN_DATA0] = BU27034_REG_MODE_CONTROL2,
> +		[BU27034_CHAN_DATA1] = BU27034_REG_MODE_CONTROL3,
> +	};
blank line here

> +	ret = regmap_read(data->regmap, reg[chan], &val);
> +	if (ret)
> +		return ret;

...

>  
>  struct bu27034_lx_coeff {
> @@ -887,21 +710,16 @@ static int bu27034_fixp_calc_lx(unsigned int ch0, unsigned int ch1,
>  {
>  	static const struct bu27034_lx_coeff coeff[] = {
>  		{
> -			.A = 31265280,		/* 3.126528 */
> -			.B = 1157400832,	/*115.7400832 */
> -			.C = 681982976,		/* -68.1982976 */
> -			.is_neg = {false, false, true},
> +			.A = 4780800,		/* -0.47808 */
> +			.B = 64400000,		/*6.44 */


/* 6.44 */
It was odd before but might as well tidy that up!

> +			.C = 190880000,		/* 19.088 */
> +			.is_neg = {true, false, false},
{ true, false, false }
Tidy that up as well.
>  		}, {
> -			.A = 3489024,		/* 0.3489024 */
> -			.B = 137210309,		/* 13.721030912 */
> -			.C = 226606476,		/* 22.66064768 */
> +			.A = 0,			/* 0 */
> +			.B = 19123200,		/* 1.91232 */
> +			.C = 305408000,		/* 30.5408 */
>  			/* All terms positive */
> -		}, {
> -			.A = 453120,		/* -0.045312 */
> -			.B = 7068160,		/* -0.706816 */
> -			.C = 374809600,		/* 37.48096 */
> -			.is_neg = {true, true, false},
> -		}
> +		},
>  	};

...

> @@ -1065,12 +882,10 @@ static int bu27034_get_single_result(struct bu27034_data *data, int chan,
>   * D1 = data1/ch1_gain/meas_time_ms * 25600
>   *
>   * Then:
> - * if (D1/D0 < 0.87)
> - *	lx = (0.001331 * D0 + 0.0000354 * D1) * ((D1 / D0 - 0.87) * 3.45 + 1)
> - * else if (D1/D0 < 1)
> - *	lx = (0.001331 * D0 + 0.0000354 * D1) * ((D1 / D0 - 0.87) * 0.385 + 1)
> - * else
> - *	lx = (0.001331 * D0 + 0.0000354 * D1) * ((D1 / D0 - 2) * -0.05 + 1)
> + * If (D1/D0 < 1.5)
> + *    lx = (0.001193 * D0 + (-0.0000747) * D1) * ((D1/D0 – 1.5) * (0.25) + 1)

Brackets around 0.25 odd.  The negative one might be justified if the code
is such that   you can't just do D0 - 0.0000747 instead.

> + * Else
> + *    lx = (0.001193* D0 + (-0.0000747) * D1)
Space between 3 and *

>   *
>   * We use it here. Users who have for example some colored lens
>   * need to modify the calculation but I hope this gives a starting point for
> @@ -1139,7 +954,7 @@ static int bu27034_calc_mlux(struct bu27034_data *data, __le16 *res, int *val)
>  
>  static int bu27034_get_mlux(struct bu27034_data *data, int chan, int *val)
>  {
> -	__le16 res[3];
> +	__le16 res[BU27034_NUM_HW_DATA_CHANS];
>  	int ret;
>  
>  	ret = bu27034_meas_set(data, true);