devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: <andrea.merello@iit.it>
To: <jic23@kernel.org>, <mchehab+huawei@kernel.org>,
	<linux-iio@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<devicetree@vger.kernel.org>
Cc: <lars@metafoo.de>, <robh+dt@kernel.org>,
	<andy.shevchenko@gmail.com>, <matt.ranostay@konsulko.com>,
	<ardeleanalex@gmail.com>, <jacopo@jmondi.org>,
	<andrea.merello@gmail.com>, <bagasdotme@gmail.com>,
	Andrea Merello <andrea.merello@iit.it>
Subject: [v7 09/14] iio: document bno055 private sysfs attributes
Date: Wed, 7 Sep 2022 15:22:00 +0200	[thread overview]
Message-ID: <20220907132205.28021-10-andrea.merello@iit.it> (raw)
In-Reply-To: <20220907132205.28021-1-andrea.merello@iit.it>

From: Andrea Merello <andrea.merello@iit.it>

Add ABI documentation for bno055 driver private sysfs attributes.

Signed-off-by: Andrea Merello <andrea.merello@iit.it>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
---
 .../ABI/testing/sysfs-bus-iio-bno055          | 81 +++++++++++++++++++
 1 file changed, 81 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-bno055

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-bno055 b/Documentation/ABI/testing/sysfs-bus-iio-bno055
new file mode 100644
index 000000000000..f32b1644e986
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-bno055
@@ -0,0 +1,81 @@
+What:		/sys/bus/iio/devices/iio:deviceX/in_accel_raw_range
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Raw (unscaled) range for acceleration readings. Unit after
+		application of scale is m/s^2. Note that this doesn't affects
+		the scale (which should be used when changing the maximum and
+		minimum readable value affects also the reading scaling factor).
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_anglvel_raw_range
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Range for angular velocity readings in radians per second. Note
+		that this does not affects the scale (which should be used when
+		changing the maximum and minimum readable value affects also the
+		reading scaling factor).
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_accel_raw_range_available
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		List of allowed values for in_accel_raw_range attribute
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_anglvel_raw_range_available
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		List of allowed values for in_anglvel_raw_range attribute
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_magn_calibration_fast_enable
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Can be 1 or 0. Enables/disables the "Fast Magnetometer
+		Calibration" HW function.
+
+What:		/sys/bus/iio/devices/iio:deviceX/fusion_enable
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Can be 1 or 0. Enables/disables the "sensor fusion" (a.k.a.
+		NDOF) HW function.
+
+What:		/sys/bus/iio/devices/iio:deviceX/calibration_data
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reports the binary calibration data blob for the IMU sensors.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_accel_calibration_auto_status
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reports the autocalibration status for the accelerometer sensor.
+		Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+		the number, the better the calibration status.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_gyro_calibration_auto_status
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reports the autocalibration status for the gyroscope sensor.
+		Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+		the number, the better the calibration status.
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_magn_calibration_auto_status
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reports the autocalibration status for the magnetometer sensor.
+		Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+		the number, the better the calibration status.
+
+What:		/sys/bus/iio/devices/iio:deviceX/sys_calibration_auto_status
+KernelVersion:	6.1
+Contact:	linux-iio@vger.kernel.org
+Description:
+		Reports the status for the IMU overall autocalibration.
+		Can be 0 (calibration non even enabled) or 1 to 5 where the greater
+		the number, the better the calibration status.
-- 
2.17.1


  parent reply	other threads:[~2022-09-07 13:37 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-07 13:21 [v7 00/14] Add support for Bosch BNO055 IMU andrea.merello
2022-09-07 13:21 ` [v7 01/14] iio: add modifiers for linear acceleration andrea.merello
2022-09-07 13:21 ` [v7 02/14] iio: document linear acceleration modifiers andrea.merello
2022-09-07 13:21 ` [v7 03/14] iio: event_monitor: add " andrea.merello
2022-09-07 13:21 ` [v7 04/14] iio: add modifers for pitch, yaw, roll andrea.merello
2022-09-07 13:21 ` [v7 05/14] iio: document pitch, yaw, roll modifiers andrea.merello
2022-09-07 13:21 ` [v7 06/14] iio: event_monitor: add pitch, yaw and " andrea.merello
2022-09-07 13:21 ` [v7 07/14] iio: add support for binary attributes andrea.merello
2022-09-07 13:21 ` [v7 08/14] iio: imu: add Bosch Sensortec BNO055 core driver andrea.merello
2022-09-18 17:27   ` Jonathan Cameron
2022-09-23  7:25     ` Andrea Merello
2022-09-07 13:22 ` andrea.merello [this message]
2022-09-07 13:22 ` [v7 10/14] iio: document "serialnumber" sysfs attribute andrea.merello
2022-09-07 13:22 ` [v7 11/14] dt-bindings: iio/imu: Add Bosch BNO055 andrea.merello
2022-09-07 13:22 ` [v7 12/14] iio: imu: add BNO055 serdev driver andrea.merello
2022-09-07 13:22 ` [v7 13/14] iio: imu: add BNO055 I2C driver andrea.merello
2022-09-07 14:09   ` Andy Shevchenko
2022-09-08  6:42     ` Andrea Merello
2022-09-18 17:26       ` Jonathan Cameron
2022-09-07 13:22 ` [v7 14/14] docs: iio: add documentation for BNO055 driver andrea.merello
2022-09-07 14:12 ` [v7 00/14] Add support for Bosch BNO055 IMU Andy Shevchenko
2022-09-18 17:30   ` Jonathan Cameron
2022-09-08  3:47 ` Bagas Sanjaya
2022-09-08  6:51   ` Andrea Merello
2022-09-08  7:32     ` Bagas Sanjaya
2022-09-08 12:40       ` 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=20220907132205.28021-10-andrea.merello@iit.it \
    --to=andrea.merello@iit.it \
    --cc=andrea.merello@gmail.com \
    --cc=andy.shevchenko@gmail.com \
    --cc=ardeleanalex@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=jacopo@jmondi.org \
    --cc=jic23@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=matt.ranostay@konsulko.com \
    --cc=mchehab+huawei@kernel.org \
    --cc=robh+dt@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).