All of lore.kernel.org
 help / color / mirror / Atom feed
From: Thomas Marangoni <Thomas.Marangoni@becom-group.com>
To: linux-hwmon@vger.kernel.org
Cc: robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org,
	linux@roeck-us.net, corbet@lwn.net, Jonathan.Cameron@huawei.com,
	Frank.Li@nxp.com, michal.simek@amd.com,
	rodrigo.gobbi.7@gmail.com, chou.cosmo@gmail.com,
	wenswang@yeah.net, nuno.sa@analog.com, paweldembicki@gmail.com,
	apokusinski01@gmail.com, eajames@linux.ibm.com,
	vassilisamir@gmail.com, heiko@sntech.de,
	neil.armstrong@linaro.org,
	prabhakar.mahadev-lad.rj@bp.renesas.com,
	kever.yang@rock-chips.com, mani@kernel.org, dev@kael-k.io,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org,
	Thomas Marangoni <Thomas.Marangoni@becom-group.com>
Subject: [PATCH 2/4] hwmon: documentation: add tids
Date: Mon, 17 Nov 2025 13:38:04 +0100	[thread overview]
Message-ID: <20251117123809.47488-3-Thomas.Marangoni@becom-group.com> (raw)
In-Reply-To: <20251117123809.47488-1-Thomas.Marangoni@becom-group.com>

Add tids driver documentation
---
 Documentation/hwmon/tids.rst | 61 ++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/hwmon/tids.rst

diff --git a/Documentation/hwmon/tids.rst b/Documentation/hwmon/tids.rst
new file mode 100644
index 000000000000..f3fea4e416ea
--- /dev/null
+++ b/Documentation/hwmon/tids.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Kernel driver tids
+===================
+
+Supported Chips:
+
+  * WSEN TIDS
+
+    Prefix: 'tids'
+
+    Addresses scanned: None
+
+    Datasheet:
+
+      English: https://www.we-online.com/components/products/manual/Manual-um-wsen-tids-2521020222501%20(rev1.2).pdf
+
+Author: Thomas Marangoni <Thomas.Marangoni@becom-group.com>
+
+
+Description
+-----------
+
+This driver implements support for the WSEN TIDS chip, a temperature
+sensor. Temperature is measured in degree celsius. In sysfs interface,
+all values are scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500.
+
+Usage Notes
+-----------
+
+The device communicates with the I2C protocol. Sensors can have the I2C
+address 0x38 or 0x3F. See Documentation/i2c/instantiating-devices.rst for methods
+to instantiate the device.
+
+Sysfs entries
+-------------
+
+=============== ============================================
+temp1_input     Measured temperature in millidegrees Celsius
+update_interval The interval for polling the sensor, in
+                milliseconds. Writable. Must be 5, 10, 20
+                or 40.
+temp1_max_hyst  The temperature in millidegrees Celsius, that
+                is triggering the temp1_max_alarm. Writable.
+                The lowest possible value is -39680 and the
+                highest possible value is 122880. Values are
+                saved in steps of 640.
+temp1_min_hyst  The temperature in millidegrees Celsius, that
+                is triggering the temp1_min_alarm. Writable.
+                The lowest possible value is -39680 and the
+                highest possible value is 122880. Values are
+                saved in steps of 640.
+temp1_max_alarm The alarm will be triggered when the level
+                reaches the value specified in
+                temp1_max_hyst. It will reset automatically
+                once it has been read.
+temp1_min_alarm The alarm will be triggered when the level
+                reaches the value specified in
+                temp1_min_hyst. It will reset automatically
+                once it has been read.
+=============== ============================================
-- 
2.51.1


  parent reply	other threads:[~2025-11-17 12:40 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-17 12:38 [PATCH 0/4] hwmon: Add driver for wsen tids-2521020222501 Thomas Marangoni
2025-11-17 12:38 ` [PATCH 1/4] " Thomas Marangoni
2025-11-17 16:24   ` Guenter Roeck
2025-11-19 10:40     ` Thomas Marangoni
2025-11-17 12:38 ` Thomas Marangoni [this message]
2025-11-17 16:31   ` [PATCH 2/4] hwmon: documentation: add tids Guenter Roeck
2025-11-17 12:38 ` [PATCH 3/4] dt-bindings: Add tids in bindings and wsen as vendor Thomas Marangoni
2025-11-17 16:27   ` Guenter Roeck
2025-11-17 16:33   ` Krzysztof Kozlowski
2025-11-17 12:38 ` [PATCH 4/4] MAINTAINERS: Add tids driver as maintained Thomas Marangoni
2025-11-17 16:31   ` Krzysztof Kozlowski

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=20251117123809.47488-3-Thomas.Marangoni@becom-group.com \
    --to=thomas.marangoni@becom-group.com \
    --cc=Frank.Li@nxp.com \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=apokusinski01@gmail.com \
    --cc=chou.cosmo@gmail.com \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dev@kael-k.io \
    --cc=devicetree@vger.kernel.org \
    --cc=eajames@linux.ibm.com \
    --cc=heiko@sntech.de \
    --cc=kever.yang@rock-chips.com \
    --cc=krzk+dt@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=mani@kernel.org \
    --cc=michal.simek@amd.com \
    --cc=neil.armstrong@linaro.org \
    --cc=nuno.sa@analog.com \
    --cc=paweldembicki@gmail.com \
    --cc=prabhakar.mahadev-lad.rj@bp.renesas.com \
    --cc=robh@kernel.org \
    --cc=rodrigo.gobbi.7@gmail.com \
    --cc=vassilisamir@gmail.com \
    --cc=wenswang@yeah.net \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.