linux-kernel - Re: [PATCH] iio: kx022a: document new chip

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <hv7kqspym5qkcwbw4r6ogi362sbooohijplxbkro5qdmndvhr6@t2cftbs4n7rz>
Date: Mon, 2 Dec 2024 14:41:26 +0100
From: Mehdi Djait <mehdi.djait@...ux.intel.com>
To: Matti Vaittinen <mazziesaccount@...il.com>
Cc: Matti Vaittinen <matti.vaittinen@...rohmeurope.com>, 
	Jonathan Cameron <jic23@...nel.org>, Lars-Peter Clausen <lars@...afoo.de>, linux-iio@...r.kernel.org, 
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] iio: kx022a: document new chip_info structure members

Hi Matti,

Thank you for the patch!

On Mon, Dec 02, 2024 at 01:47:42PM +0200, Matti Vaittinen wrote:
> The kx022a driver supports a few different HW variants. A chip-info
> structure is used to describe sensor specific details. Support for
> sensors with different measurement g-ranges was added recently,
> introducing sensor specific scale arrays.
> 
> The members of the chip-info structure have been documented using
> kerneldoc. The newly added members omitted the documentation. It is nice
> to have all the entries documented for the sake of the consistency.
> Furthermore, the scale table format may not be self explatonary, nor how
> the amount of scales is informed.
> 
> Add documentation to scale table entries to maintain consistency and to
> make it more obvious how the scales should be represented.
> 
> Suggested-by: Mehdi Djait <mehdi.djait@...ux.intel.com>
> Signed-off-by: Matti Vaittinen <mazziesaccount@...il.com>
> 
> ---
> Wording is difficult. Especially when not working on ones native
> language. So, I am glad is someone evaluates whether using the 'NANO'
> to describe 0.000 000 001 is correct - or if term like 'ppb' would make
> more sense...
> ---
>  drivers/iio/accel/kionix-kx022a.h | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/drivers/iio/accel/kionix-kx022a.h b/drivers/iio/accel/kionix-kx022a.h
> index 142652ff4b22..82c4ced7426d 100644
> --- a/drivers/iio/accel/kionix-kx022a.h
> +++ b/drivers/iio/accel/kionix-kx022a.h
> @@ -137,6 +137,11 @@ struct kx022a_data;
>   *
>   * @name:			name of the device
>   * @regmap_config:		pointer to register map configuration
> + * scale_table:			Array of two integer tables containing
> + *				supported scales. Each scale is represented
> + *				a 2 value array. First value being full
> + *				integers, second being NANOs.

How about: 

Array of tables containing two scaling factors for the supported
acceleration measurement ranges. First value is the integer part and
second value is the fractional part in nano units.

> + * scale_table_size:		Amount of values in tables.
>   * @channels:			pointer to iio_chan_spec array
>   * @num_channels:		number of iio_chan_spec channels
>   * @fifo_length:		number of 16-bit samples in a full buffer
> -- 
> 2.47.0
> 

--
Kind Regards
Mehdi Djait