]> git.ipfire.org Git - thirdparty/linux.git/commit
iio: kx022a: document new chip_info structure members
authorMatti Vaittinen <mazziesaccount@gmail.com>
Fri, 6 Dec 2024 09:26:42 +0000 (11:26 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Sun, 8 Dec 2024 18:26:31 +0000 (18:26 +0000)
commita8ec0b44c7c5116805f252da624264652be1de71
treec33d04e45ca3353c7d562d7134ce21766d5b7f83
parent56f8c1759be90f139056a61328ffbf168cef895f
iio: kx022a: document new chip_info structure members

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@linux.intel.com>
Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com>
Reviewed-by: Mehdi Djait <mehdi.djait@linux.intel.com>
Link: https://patch.msgid.link/Z1LDUj-naUdGSM6n@mva-rohm
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
drivers/iio/accel/kionix-kx022a.h