Commit 0e2bf22a authored by Lorenzo Bianconi's avatar Lorenzo Bianconi Committed by Jonathan Cameron
Browse files

iio: imu: st_lsm6dsx: improve kernel docs and comments 



Improve kernel docs and comments reporting supported sensors in a list in
order to make more easy to add new devices in the future.

Signed-off-by: default avatarLorenzo Bianconi <lorenzo@kernel.org>
Link: https://lore.kernel.org/r/d365d048253d2ff9ee0092d391bbaa9cf0737cff.1706961432.git.lorenzo@kernel.org


Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent 129e8619

drivers/iio/imu/st_lsm6dsx/Kconfig

+25 −5
Original line number Diff line number Diff line
@@ -11,11 +11,31 @@ config IIO_ST_LSM6DSX 
	select IIO_ST_LSM6DSX_I3C if (I3C)

	help

	  Say yes here to build support for STMicroelectronics LSM6DSx imu

	  sensor. Supported devices: lsm6ds3, lsm6ds3h, lsm6dsl, lsm6dsm,

	  ism330dlc, lsm6dso, lsm6dsox, asm330lhh, asm330lhhx, lsm6dsr,

	  lsm6ds3tr-c, ism330dhcx, lsm6dsrx, lsm6ds0, lsm6dsop, lsm6dstx,

	  lsm6dsv, lsm6dsv16x, lsm6dso16is, ism330is, asm330lhb, lsm6dst

	  and the accelerometer/gyroscope of lsm9ds1.

	  sensor.

	  Supported devices:

	  - asm330lhb

	  - asm330lhh

	  - asm330lhhx

	  - ism330dhcx

	  - ism330dlc

	  - ism330is

	  - lsm6ds0

	  - lsm6ds3

	  - lsm6ds3h

	  - lsm6ds3tr-c

	  - lsm6dsl

	  - lsm6dsm

	  - lsm6dso

	  - lsm6dso16is

	  - lsm6dsop

	  - lsm6dsox

	  - lsm6dsr

	  - lsm6dsrx

	  - lsm6dst

	  - lsm6dstx

	  - lsm6dsv

	  - lsm6dsv16x

	  - lsm9ds1



	  To compile this driver as a module, choose M here: the module

	  will be called st_lsm6dsx.

drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_buffer.c

+24 −3
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
/*

 * STMicroelectronics st_lsm6dsx FIFO buffer library driver

 *

 * LSM6DS3/LSM6DS3H/LSM6DSL/LSM6DSM/ISM330DLC/LSM6DS3TR-C:

 * Pattern FIFO:

 * The FIFO buffer can be configured to store data from gyroscope and

 * accelerometer. Samples are queued without any tag according to a

 * specific pattern based on 'FIFO data sets' (6 bytes each):
@@ -14,12 +14,33 @@ 
 * (e.g. Gx, Gy, Gz, Ax, Ay, Az), then data are repeated depending on the

 * value of the decimation factor and ODR set for each FIFO data set.

 *

 * LSM6DSO/LSM6DSOX/ASM330LHH/ASM330LHHX/LSM6DSR/LSM6DSRX/ISM330DHCX/

 * LSM6DST/LSM6DSOP/LSM6DSTX/LSM6DSV/ASM330LHB:

 * Supported devices:

 * - ISM330DLC

 * - LSM6DS3

 * - LSM6DS3H

 * - LSM6DS3TR-C

 * - LSM6DSL

 * - LSM6DSM

 *

 * Tagged FIFO:

 * The FIFO buffer can be configured to store data from gyroscope and

 * accelerometer. Each sample is queued with a tag (1B) indicating data

 * source (gyroscope, accelerometer, hw timer).

 *

 * Supported devices:

 * - ASM330LHB

 * - ASM330LHH

 * - ASM330LHHX

 * - ISM330DHCX

 * - LSM6DSO

 * - LSM6DSOP

 * - LSM6DSOX

 * - LSM6DSR

 * - LSM6DSRX

 * - LSM6DST

 * - LSM6DSTX

 * - LSM6DSV

 *

 * FIFO supported modes:

 *  - BYPASS: FIFO disabled

 *  - CONTINUOUS: FIFO enabled. When the buffer is full, the FIFO index

drivers/iio/imu/st_lsm6dsx/st_lsm6dsx_core.c

+22 −6
Original line number Diff line number Diff line
@@ -14,34 +14,50 @@ 
 * by a different driver.

 *

 * Supported sensors:

 * - LSM6DS3:

 *

 * - LSM6DS3

 *   - Accelerometer/Gyroscope supported ODR [Hz]: 12.5, 26, 52, 104, 208, 416

 *   - Accelerometer supported full-scale [g]: +-2/+-4/+-8/+-16

 *   - Gyroscope supported full-scale [dps]: +-125/+-245/+-500/+-1000/+-2000

 *   - FIFO size: 8KB

 *

 * - LSM6DS3H/LSM6DSL/LSM6DSM/ISM330DLC/LSM6DS3TR-C:

 * - ISM330DLC

 * - LSM6DS3H

 * - LSM6DS3TR-C

 * - LSM6DSL

 * - LSM6DSM

 *   - Accelerometer/Gyroscope supported ODR [Hz]: 12.5, 26, 52, 104, 208, 416

 *   - Accelerometer supported full-scale [g]: +-2/+-4/+-8/+-16

 *   - Gyroscope supported full-scale [dps]: +-125/+-245/+-500/+-1000/+-2000

 *   - FIFO size: 4KB

 *

 * - LSM6DSO/LSM6DSOX/ASM330LHH/ASM330LHHX/LSM6DSR/ISM330DHCX/LSM6DST/LSM6DSOP/

 *   LSM6DSTX/LSM6DSO16IS/ISM330IS:

 * - ASM330LHH

 * - ASM330LHHX

 * - ISM330DHCX

 * - ISM330IS

 * - LSM6DSO

 * - LSM6DSO16IS

 * - LSM6DSOP

 * - LSM6DSOX

 * - LSM6DSR

 * - LSM6DST

 * - LSM6DSTX

 *   - Accelerometer/Gyroscope supported ODR [Hz]: 12.5, 26, 52, 104, 208, 416,

 *     833

 *   - Accelerometer supported full-scale [g]: +-2/+-4/+-8/+-16

 *   - Gyroscope supported full-scale [dps]: +-125/+-245/+-500/+-1000/+-2000

 *   - FIFO size: 3KB

 *

 * - LSM6DSV/LSM6DSV16X:

 * - LSM6DSV

 * - LSM6DSV16X

 *   - Accelerometer/Gyroscope supported ODR [Hz]: 7.5, 15, 30, 60, 120, 240,

 *     480, 960

 *   - Accelerometer supported full-scale [g]: +-2/+-4/+-8/+-16

 *   - Gyroscope supported full-scale [dps]: +-125/+-250/+-500/+-1000/+-2000

 *   - FIFO size: 3KB

 *

 * - LSM9DS1/LSM6DS0:

 * - LSM6DS0

 * - LSM9DS1

 *   - Accelerometer supported ODR [Hz]: 10, 50, 119, 238, 476, 952

 *   - Accelerometer supported full-scale [g]: +-2/+-4/+-8/+-16

 *   - Gyroscope supported ODR [Hz]: 15, 60, 119, 238, 476, 952